From 0c57ada72df7cc6c42c67046f6a8a183d7fec6cc Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Mon, 20 Apr 2026 11:31:47 -0700 Subject: [PATCH 1/2] feat(docs): publish interface refdocs along with the classes they implement --- dev/composer.json | 3 +- dev/src/DocFx/Node/ClassNode.php | 36 + dev/src/DocFx/Node/InterfaceNode.php | 72 + dev/src/DocFx/Page/PageTree.php | 82 +- dev/tests/Unit/DocFx/PageTest.php | 35 +- dev/tests/fixtures/docfx/NewClient/toc.yml | 8 +- .../docfx/Vision/V1.ImageAnnotatorClient.yml | 577 - .../docfx/Vision/V1.ProductSearchClient.yml | 14 - dev/tests/fixtures/phpdoc/auth.xml | 17605 ++++++ .../phpdoc/{structure.xml => vision.xml} | 48277 ++++++---------- 10 files changed, 35138 insertions(+), 31571 deletions(-) create mode 100644 dev/src/DocFx/Node/InterfaceNode.php delete mode 100644 dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml delete mode 100644 dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml create mode 100644 dev/tests/fixtures/phpdoc/auth.xml rename dev/tests/fixtures/phpdoc/{structure.xml => vision.xml} (64%) diff --git a/dev/composer.json b/dev/composer.json index 4d8780f84a36..497fadd2e33d 100644 --- a/dev/composer.json +++ b/dev/composer.json @@ -12,7 +12,8 @@ "twig/twig": "^3.5", "phpstan/phpstan": "^2.0", "symfony/finder": "^6.2", - "nikic/php-parser": "v5.7.0" + "nikic/php-parser": "v5.7.0", + "kcs/class-finder": "^0.6.1" }, "autoload": { "psr-4": { diff --git a/dev/src/DocFx/Node/ClassNode.php b/dev/src/DocFx/Node/ClassNode.php index 76c81c0b2b1a..3c1aa72a957a 100644 --- a/dev/src/DocFx/Node/ClassNode.php +++ b/dev/src/DocFx/Node/ClassNode.php @@ -258,4 +258,40 @@ public function setTocName(string $tocName) { $this->tocName = $tocName; } + + public function excludeFromDocs(): bool + { + // Skip the protobuf classes with underscores, they're all deprecated + // @TODO: Do not generate them in V2 + if (false !== strpos($this->getName(), '_')) { + return true; + } + + // Skip deprecated classes + if ('deprecated' === $this->getStatus()) { + return true; + } + + // Manually skip GAPIC base clients + if ($this->isServiceBaseClass()) { + + return true; + } + + // Skip internal classes + if ($this->isInternal()) { + return true; + } + + // Manually skip Grpc classes + // @TODO: remove this once we no longer have V2 classes + if ( + 'GrpcClient' === substr($this->getFullName(), -10) + && '\Grpc\BaseStub' === $this->getExtends() + ) { + return true; + } + + return false; + } } diff --git a/dev/src/DocFx/Node/InterfaceNode.php b/dev/src/DocFx/Node/InterfaceNode.php new file mode 100644 index 000000000000..2a4154e918f6 --- /dev/null +++ b/dev/src/DocFx/Node/InterfaceNode.php @@ -0,0 +1,72 @@ +in($componentDirs) + ->implementationOf($this->getFullName()); + + foreach ($finder as $className => $reflection) { + // ensure the class is part of our published documentation + if (isset($pageNodes['\\' . $className])) { + $this->implementingClasses[] = '\\' . $className; + } + } + } + + public function getLongDescription(): string + { + $longDescription = parent::getLongDescription(); + if (empty($this->implementingClasses)) { + return $longDescription; + } + $longDescription .= empty($longDescription) ? '' : "\n"; + $longDescription .= 'Classes which implement this interface in this package:'; + + foreach ($this->implementingClasses as $className) { + $longDescription .= sprintf("\n - {@see %s}", $className); + } + + return $longDescription; + } +} diff --git a/dev/src/DocFx/Page/PageTree.php b/dev/src/DocFx/Page/PageTree.php index d7d2b595edaf..01b0d31fab1f 100644 --- a/dev/src/DocFx/Page/PageTree.php +++ b/dev/src/DocFx/Page/PageTree.php @@ -18,6 +18,7 @@ namespace Google\Cloud\Dev\DocFx\Page; use Google\Cloud\Dev\DocFx\Node\ClassNode; +use Google\Cloud\Dev\DocFx\Node\InterfaceNode; use Google\Cloud\Dev\DocFx\Toc\NamespaceToc; use SimpleXMLElement; @@ -54,58 +55,41 @@ private function loadPages(): array // List of pages, to sort alphabetically by key $pageMap = []; - $isDiregapic = false; - $gapicClients = []; + $interfaces = []; // Build the list of pages we are going to generate documentation for foreach ($structure->file as $file) { - // only document classes for now - if (!isset($file->class[0])) { + if (!isset($file->class[0]) && !isset($file->interface[0])) { + // only document classes and interfaces for now continue; } - $classNode = new ClassNode($file->class[0], $this->componentPackages); + $node = isset($file->class[0]) + ? new ClassNode($file->class[0], $this->componentPackages) + : new InterfaceNode($file->interface[0], $this->componentPackages); - // Skip the protobuf classes with underscores, they're all deprecated - // @TODO: Do not generate them in V2 - if (false !== strpos($classNode->getName(), '_')) { - continue; + if ($node instanceof InterfaceNode) { + $interfaces[] = $node; } - // Skip deprecated classes - if ('deprecated' === $classNode->getStatus()) { - continue; - } - - // Manually skip GAPIC base clients - if ($classNode->isServiceBaseClass()) { - $gapicClients[] = $classNode; - continue; - } - - // Skip internal classes - if ($classNode->isInternal()) { + if ($node->excludeFromDocs()) { + // Keep track of base clients + if ($node->isServiceBaseClass()) { + $gapicClients[] = $node; + } continue; } - $this->hasV1Client |= $classNode->isV1ServiceClass(); - $this->hasV2Client |= $classNode->isV2ServiceClass(); + $this->hasV1Client |= $node->isV1ServiceClass(); + $this->hasV2Client |= $node->isV2ServiceClass(); // Manually skip protobuf enums in favor of Gapic enums (see below). // @TODO: Do not generate them in V2, eventually mark them as deprecated - $isDiregapic = $isDiregapic || $classNode->isGapicEnumClass(); - - // Manually skip Grpc classes - // @TODO: Do not generate Grpc classes in V2, eventually mark these as deprecated - $fullName = $classNode->getFullname(); - if ( - 'GrpcClient' === substr($fullName, -10) - && '\Grpc\BaseStub' === $classNode->getExtends() - ) { - continue; - } + $isDiregapic |= $node->isGapicEnumClass(); + + $fullName = $node->getFullname(); // Skip classes that are in the structure.xml but not a part of this namespace if (0 !== strpos($fullName, '\\' . $this->namespace)) { @@ -113,7 +97,7 @@ private function loadPages(): array } $pageMap[$fullName] = new Page( - $classNode, + $node, $file['path'], $this->packageDescription, $this->componentPath @@ -132,27 +116,23 @@ private function loadPages(): array } } + /** + * Determine all classes which implement an interface in this library, + * so that we can list them in the interface's reference documentation. + */ + foreach ($interfaces as $interface) { + $interface->determineImplementingClasses($pageMap); + } + // Combine Client classes with internal Gapic\Client $pageMap = $this->combineGapicClients($gapicClients, $pageMap); + // Sort pages alphabetically by full class name + ksort($pageMap); + // We no longer need the array keys $pages = array_values($pageMap); - // Mark V2 services as "beta" if they have a V1 client - if ($this->hasV1Client && $this->hasV2Client) { - foreach ($pages as $page) { - if ($page->getClassNode()->isV2ServiceClass()) { - $page->getClassNode()->setTocName(sprintf( - '%s (beta)', - $page->getClassNode()->getName() - )); - } - } - } - - // Sort pages alphabetically by full class name - ksort($pages); - return $pages; } diff --git a/dev/tests/Unit/DocFx/PageTest.php b/dev/tests/Unit/DocFx/PageTest.php index 39702705040c..3b7e769c1e51 100644 --- a/dev/tests/Unit/DocFx/PageTest.php +++ b/dev/tests/Unit/DocFx/PageTest.php @@ -17,8 +17,11 @@ namespace Google\Cloud\Dev\Tests\Unit\DocFx; +use Google\Auth\Credentials\ServiceAccountCredentials; +use Google\Auth\FetchAuthTokenInterface; use PHPUnit\Framework\TestCase; use Google\Cloud\Dev\DocFx\Node\ClassNode; +use Google\Cloud\Dev\DocFx\Node\InterfaceNode; use Google\Cloud\Dev\DocFx\Page\OverviewPage; use Google\Cloud\Dev\DocFx\Page\Page; use Google\Cloud\Dev\DocFx\Page\PageTree; @@ -65,7 +68,7 @@ public function provideFriendlyApiName() public function testLoadPagesProtoPackages() { - $structureXml = __DIR__ . '/../../fixtures/phpdoc/structure.xml'; + $structureXml = __DIR__ . '/../../fixtures/phpdoc/vision.xml'; $componentPath = __DIR__ . '/../../fixtures/component/Vision'; $protoPackages = [ 'google.longrunning' => 'Google\LongRunning', @@ -109,6 +112,36 @@ public function testOverviewPage() $this->assertStringEndsWith("\nend.", $overview4->getContents()); } + public function testInterfacePage() + { + $structureXml = __DIR__ . '/../../fixtures/phpdoc/auth.xml'; + $componentPath = __DIR__ . '/../../../vendor/google/auth'; + $protoPackages = []; + $pageTree = new PageTree( + $structureXml, + 'Google\Auth', + 'Google Auth', + $componentPath, + $protoPackages + ); + + $pages = $pageTree->getPages(); + $interfacePage = null; + foreach ($pages as $page) { + if (ltrim($page->getClassNode()->getFullname(), '\\') === FetchAuthTokenInterface::class) { + $interfacePage = $page; + break; + } + } + + $this->assertNotNull($interfacePage); + $description = $interfacePage->getItems()[0]['summary'] ?? ''; + $this->assertStringContainsString( + ServiceAccountCredentials::class, + $description + ); + } + public function testHandleSample() { $structureXml = __DIR__ . '/../../fixtures/phpdoc/clientsnippets.xml'; diff --git a/dev/tests/fixtures/docfx/NewClient/toc.yml b/dev/tests/fixtures/docfx/NewClient/toc.yml index 8a6c9ac4f4b2..8a21eb396411 100644 --- a/dev/tests/fixtures/docfx/NewClient/toc.yml +++ b/dev/tests/fixtures/docfx/NewClient/toc.yml @@ -17,11 +17,11 @@ uid: 'services:Google\Cloud\SecretManager\V1' items: - - uid: \Google\Cloud\SecretManager\V1\SecretManagerServiceClient + uid: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient name: SecretManagerServiceClient - - uid: \Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient - name: 'SecretManagerServiceClient (beta)' + uid: \Google\Cloud\SecretManager\V1\SecretManagerServiceClient + name: SecretManagerServiceClient - name: V1beta1 uid: 'ns:Google\Cloud\SecretManager\V1beta1' @@ -44,5 +44,5 @@ items: - uid: \Google\Cloud\SecretManager\V1beta2\Client\SecretManagerServiceClient - name: 'SecretManagerServiceClient (beta)' + name: SecretManagerServiceClient status: beta diff --git a/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml b/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml deleted file mode 100644 index 6c9654f7deef..000000000000 --- a/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml +++ /dev/null @@ -1,577 +0,0 @@ -### YamlMime:UniversalReference -items: - - - uid: \Google\Cloud\Vision\V1\ImageAnnotatorClient - name: ImageAnnotatorClient - friendlyApiName: 'Cloud Vision V1 Client' - id: ImageAnnotatorClient - summary: |- - Service Description: Service that performs Google Cloud Vision API detection tasks over client - images, such as face, landmark, logo, label, and text detection. The - ImageAnnotator service returns detected entities from the images. - type: class - namespace: 'Google \ Cloud \ Vision \ V1' - langs: - - php - children: - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::createImageObject()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::annotateImage()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::faceDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::landmarkDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::logoDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::labelDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::textDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::documentTextDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::safeSearchDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::imagePropertiesDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::cropHintsDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::webDetection()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::objectLocalization()' - - '\Google\Cloud\Vision\V1\ImageAnnotatorClient::productSearch()' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::createImageObject()' - name: createImageObject - id: createImageObject - summary: |- - Creates an Image object that can be used as part of an image annotation request. - - Example: - ```php - $imageResource = fopen('path/to/image.jpg', 'r'); - $image = $imageAnnotatorClient->createImageObject($imageResource); - $response = $imageAnnotatorClient->faceDetection($image); - ``` - - ```php - $imageData = file_get_contents('path/to/image.jpg'); - $image = $imageAnnotatorClient->createImageObject($imageData); - $response = $imageAnnotatorClient->faceDetection($image); - ``` - - ```php - $imageUri = "gs://my-bucket/image.jpg"; - $image = $imageAnnotatorClient->createImageObject($imageUri); - $response = $imageAnnotatorClient->faceDetection($image); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: imageInput - var_type: resource|string - description: |- - An image to configure with - the given settings. This parameter will accept a resource, a - string of bytes, or the URI of an image in a publicly-accessible - web location. - returns: - - - var_type: 'Image' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::annotateImage()' - name: annotateImage - id: annotateImage - summary: |- - Run image detection and annotation for an image. - - Example: - ```php - use Google\Cloud\Vision\V1\Feature; - use Google\Cloud\Vision\V1\Feature\Type; - - $imageResource = fopen('path/to/image.jpg', 'r'); - $features = [Type::FACE_DETECTION]; - $response = $imageAnnotatorClient->annotateImage($imageResource, $features); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: features - var_type: 'array<Feature>|int[]' - description: 'Requested features.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::faceDetection()' - name: faceDetection - id: faceDetection - summary: |- - Run face detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->faceDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::landmarkDetection()' - name: landmarkDetection - id: landmarkDetection - summary: |- - Run landmark detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->landmarkDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::logoDetection()' - name: logoDetection - id: logoDetection - summary: |- - Run logo detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->logoDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::labelDetection()' - name: labelDetection - id: labelDetection - summary: |- - Run label detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->labelDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::textDetection()' - name: textDetection - id: textDetection - summary: |- - Run text detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->textDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::documentTextDetection()' - name: documentTextDetection - id: documentTextDetection - summary: |- - Run document text detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->documentTextDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::safeSearchDetection()' - name: safeSearchDetection - id: safeSearchDetection - summary: |- - Run safe search detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->safeSearchDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::imagePropertiesDetection()' - name: imagePropertiesDetection - id: imagePropertiesDetection - summary: |- - Run image properties detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->imagePropertiesDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::cropHintsDetection()' - name: cropHintsDetection - id: cropHintsDetection - summary: |- - Run crop hints detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->cropHintsDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::webDetection()' - name: webDetection - id: webDetection - summary: |- - Run web detection for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->webDetection($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::objectLocalization()' - name: objectLocalization - id: objectLocalization - summary: |- - Run object localization for an image. - - Example: - ```php - $imageContent = file_get_contents('path/to/image.jpg'); - $response = $imageAnnotatorClient->objectLocalization($imageContent); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' - - - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::productSearch()' - name: productSearch - id: productSearch - summary: |- - Run product search for an image. - - Example: - ```php - use Google\Cloud\Vision\V1\ProductSearchClient; - use Google\Cloud\Vision\V1\ProductSearchParams; - - $imageContent = file_get_contents('path/to/image.jpg'); - $productSetName = ProductSearchClient::productSetName('PROJECT_ID', 'LOC_ID', 'PRODUCT_SET_ID'); - $productSearchParams = (new ProductSearchParams) - ->setProductSet($productSetName); - $response = $imageAnnotatorClient->productSearch( - $imageContent, - $productSearchParams - ); - ``` - parent: \Google\Cloud\Vision\V1\ImageAnnotatorClient - type: method - langs: - - php - syntax: - parameters: - - - id: image - var_type: 'resource|string|Image' - description: 'The image to be processed.' - - - id: productSearchParams - var_type: 'ProductSearchParams' - description: |- - Parameters for a product search request. Please note, this - value will override the ProductSearchParams in the - ImageContext instance if provided. - - - id: optionalArgs - var_type: array - description: 'Configuration Options.' - - - id: '↳ imageContext' - var_type: ImageContext - description: 'Additional context that may accompany the image.' - - - id: '↳ retrySettings' - var_type: RetrySettings|array - description: '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: - - - var_type: 'AnnotateImageResponse' diff --git a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml deleted file mode 100644 index 27869fba91bc..000000000000 --- a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:UniversalReference -items: - - - uid: \Google\Cloud\Vision\V1\ProductSearchClient - name: ProductSearchClient - friendlyApiName: 'Cloud Vision V1 Client' - id: ProductSearchClient - summary: |- - Service Description: Manages Products and ProductSets of reference images for use in product - search. It uses the following resource model: - type: class - namespace: 'Google \ Cloud \ Vision \ V1' - langs: - - php diff --git a/dev/tests/fixtures/phpdoc/auth.xml b/dev/tests/fixtures/phpdoc/auth.xml new file mode 100644 index 000000000000..b92d96e3b1cd --- /dev/null +++ b/dev/tests/fixtures/phpdoc/auth.xml @@ -0,0 +1,17605 @@ + + + + + + + + + + + + + + + + + + + + AccessToken + \Google\Auth\AccessToken + + Wrapper around Google Access Tokens which provides convenience functions. + + + + + + + + + FEDERATED_SIGNON_CERT_URL + \Google\Auth\AccessToken::FEDERATED_SIGNON_CERT_URL + 'https://www.googleapis.com/oauth2/v3/certs' + + + + + + + + + IAP_CERT_URL + \Google\Auth\AccessToken::IAP_CERT_URL + 'https://www.gstatic.com/iap/verify/public_key-jwk' + + + + + + + + + IAP_ISSUER + \Google\Auth\AccessToken::IAP_ISSUER + 'https://cloud.google.com/iap' + + + + + + + + + OAUTH2_ISSUER + \Google\Auth\AccessToken::OAUTH2_ISSUER + 'accounts.google.com' + + + + + + + + + OAUTH2_ISSUER_HTTPS + \Google\Auth\AccessToken::OAUTH2_ISSUER_HTTPS + 'https://accounts.google.com' + + + + + + + + + OAUTH2_REVOKE_URI + \Google\Auth\AccessToken::OAUTH2_REVOKE_URI + 'https://oauth2.googleapis.com/revoke' + + + + + + + + + + httpHandler + \Google\Auth\AccessToken::$httpHandler + + + + + + + + + + + cache + \Google\Auth\AccessToken::$cache + + + + + + + + + + + + __construct + \Google\Auth\AccessToken::__construct() + + + httpHandler + null + callable|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface|null + + + + + + + + + + + + + verify + \Google\Auth\AccessToken::verify() + + + token + + string + + + + options + [] + array + + + + Verifies an id token and returns the authenticated apiLoginTicket. + Throws an exception if the id token is not valid. +The audience parameter can be used to control which id tokens are +accepted. By default, the id token must have been issued to this OAuth2 client. + + + + + + + + + + + + + + + determineAlg + \Google\Auth\AccessToken::determineAlg() + + + certs + + array + + + + Identifies the expected algorithm to verify by looking at the "alg" key +of the provided certs. + + + + + + + + + verifyEs256 + \Google\Auth\AccessToken::verifyEs256() + + + token + + string + + + + certs + + array + + + + audience + null + string|null + + + + issuer + null + string|null + + + + Verifies an ES256-signed JWT. + + + + + + + + + + + + verifyRs256 + \Google\Auth\AccessToken::verifyRs256() + + + token + + string + + + + certs + + array + + + + audience + null + string|null + + + + issuer + null + string|null + + + + Verifies an RS256-signed JWT. + + + + + + + + + + + + revoke + \Google\Auth\AccessToken::revoke() + + + token + + string|array + + + + options + [] + array + + + + Revoke an OAuth2 access token or refresh token. This method will revoke the current access +token, if a token isn't provided. + + + + + + + + + + getCerts + \Google\Auth\AccessToken::getCerts() + + + location + + string + + + + cacheKey + + string + + + + options + [] + array + + + + Gets federated sign-on certificates to use for verifying identity tokens. + Returns certs as array structure, where keys are key ids, and values +are PEM encoded certificates. + + + + + + + + + + + retrieveCertsFromLocation + \Google\Auth\AccessToken::retrieveCertsFromLocation() + + + url + + string + + + + options + [] + array + + + + Retrieve and cache a certificates file. + + + + + + + + + + + + checkAndInitializePhpsec + \Google\Auth\AccessToken::checkAndInitializePhpsec() + + + + + + + + + + + loadPhpsecPublicKey + \Google\Auth\AccessToken::loadPhpsecPublicKey() + + + modulus + + string + + + + exponent + + string + + + + + + + + + + + + + checkSimpleJwt + \Google\Auth\AccessToken::checkSimpleJwt() + + + + + + + + + + + callJwtStatic + \Google\Auth\AccessToken::callJwtStatic() + + + method + + string + + + + args + [] + array + + + + Provide a hook to mock calls to the JWT static methods. + + + + + + + + + + callSimpleJwtDecode + \Google\Auth\AccessToken::callSimpleJwtDecode() + + + args + [] + array + + + + Provide a hook to mock calls to the JWT static methods. + + + + + + + + + getCacheKeyFromCertLocation + \Google\Auth\AccessToken::getCacheKeyFromCertLocation() + + + certsLocation + + string + + + + Generate a cache key based on the cert location using sha1 with the +exception of using "federated_signon_certs_v3" to preserve BC. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ApplicationDefaultCredentials + \Google\Auth\ApplicationDefaultCredentials + + ApplicationDefaultCredentials obtains the default credentials for +authorizing a request to a Google service. + Application Default Credentials are described here: +https://developers.google.com/accounts/docs/application-default-credentials + +This class implements the search for the application default credentials as +described in the link. + +It provides three factory methods: +- #get returns the computed credentials object +- #getSubscriber returns an AuthTokenSubscriber built from the credentials object +- #getMiddleware returns an AuthTokenMiddleware built from the credentials object + +This allows it to be used as follows with GuzzleHttp\Client: + +``` +use Google\Auth\ApplicationDefaultCredentials; +use GuzzleHttp\Client; +use GuzzleHttp\HandlerStack; + +$middleware = ApplicationDefaultCredentials::getMiddleware( + 'https://www.googleapis.com/auth/taskqueue' +); +$stack = HandlerStack::create(); +$stack->push($middleware); + +$client = new Client([ + 'handler' => $stack, + 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', + 'auth' => 'google_auth' // authorize all requests +]); + +$res = $client->get('myproject/taskqueues/myqueue'); +``` + + + + + + + SDK_DEBUG_ENV_VAR + \Google\Auth\ApplicationDefaultCredentials::SDK_DEBUG_ENV_VAR + 'GOOGLE_SDK_PHP_LOGGING' + + + + + + + + + + + getSubscriber + \Google\Auth\ApplicationDefaultCredentials::getSubscriber() + + + scope + null + string|string[] + + + + httpHandler + null + callable|null + + + + cacheConfig + null + array|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface|null + + + + + + + + + + + + + + + + + + getMiddleware + \Google\Auth\ApplicationDefaultCredentials::getMiddleware() + + + scope + null + string|string[] + + + + httpHandler + null + callable|null + + + + cacheConfig + null + array|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface|null + + + + quotaProject + null + string + + + + Obtains an AuthTokenMiddleware that uses the default FetchAuthTokenInterface +implementation to use in this environment. + If supplied, $scope is used to in creating the credentials instance if +this does not fallback to the compute engine defaults. + + + + + + + + + + + + + getCredentials + \Google\Auth\ApplicationDefaultCredentials::getCredentials() + + + scope + null + string|string[] + + + + httpHandler + null + callable|null + + + + cacheConfig + null + array|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface|null + + + + quotaProject + null + string|null + + + + defaultScope + null + string|string[]|null + + + + universeDomain + null + string|null + + + + logger + null + null|false|\Psr\Log\LoggerInterface + + + + Obtains the default FetchAuthTokenInterface implementation to use +in this environment. + + + + + + + + + + + + + + + + + getIdTokenMiddleware + \Google\Auth\ApplicationDefaultCredentials::getIdTokenMiddleware() + + + targetAudience + + string + + + + httpHandler + null + callable|null + + + + cacheConfig + null + array|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface|null + + + + Obtains an AuthTokenMiddleware which will fetch an ID token to use in the +Authorization header. The middleware is configured with the default +FetchAuthTokenInterface implementation to use in this environment. + If supplied, $targetAudience is used to set the "aud" on the resulting +ID token. + + + + + + + + + + + + getProxyIdTokenMiddleware + \Google\Auth\ApplicationDefaultCredentials::getProxyIdTokenMiddleware() + + + targetAudience + + string + + + + httpHandler + null + callable|null + + + + cacheConfig + null + array|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface|null + + + + Obtains an ProxyAuthTokenMiddleware which will fetch an ID token to use in the +Authorization header. The middleware is configured with the default +FetchAuthTokenInterface implementation to use in this environment. + If supplied, $targetAudience is used to set the "aud" on the resulting +ID token. + + + + + + + + + + + + getIdTokenCredentials + \Google\Auth\ApplicationDefaultCredentials::getIdTokenCredentials() + + + targetAudience + + string + + + + httpHandler + null + callable|null + + + + cacheConfig + null + array|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface|null + + + + Obtains the default FetchAuthTokenInterface implementation to use +in this environment, configured with a $targetAudience for fetching an ID +token. + + + + + + + + + + + + + + getDefaultLogger + \Google\Auth\ApplicationDefaultCredentials::getDefaultLogger() + + + Returns a StdOutLogger instance + + + + + + + + + notFound + \Google\Auth\ApplicationDefaultCredentials::notFound() + + + + + + + + + + + onGce + \Google\Auth\ApplicationDefaultCredentials::onGce() + + + httpHandler + null + callable|null + + + + cacheConfig + null + array|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface|null + + + + + + + + + + + + + + + + + + + + + + Copyright 2024 Google Inc. All Rights Reserved. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + FileSystemCacheItemPool + \Google\Auth\Cache\FileSystemCacheItemPool + + + + + + + + \Psr\Cache\CacheItemPoolInterface + + + + cachePath + \Google\Auth\Cache\FileSystemCacheItemPool::$cachePath + + + + + + + + + + + buffer + \Google\Auth\Cache\FileSystemCacheItemPool::$buffer + [] + + + + + + + + + + + __construct + \Google\Auth\Cache\FileSystemCacheItemPool::__construct() + + + path + + string + + + + Creates a FileSystemCacheItemPool cache that stores values in local storage + + + + + + + + getItem + \Google\Auth\Cache\FileSystemCacheItemPool::getItem() + + + key + + string + + + + {@inheritdoc} + + + + + + + getItems + \Google\Auth\Cache\FileSystemCacheItemPool::getItems() + + + keys + [] + array + + + + {@inheritdoc} + + + + + + + + save + \Google\Auth\Cache\FileSystemCacheItemPool::save() + + + item + + \Psr\Cache\CacheItemInterface + + + + {@inheritdoc} + + + + + + + hasItem + \Google\Auth\Cache\FileSystemCacheItemPool::hasItem() + + + key + + string + + + + {@inheritdoc} + + + + + + + clear + \Google\Auth\Cache\FileSystemCacheItemPool::clear() + + + {@inheritdoc} + + + + + + + deleteItem + \Google\Auth\Cache\FileSystemCacheItemPool::deleteItem() + + + key + + string + + + + {@inheritdoc} + + + + + + + deleteItems + \Google\Auth\Cache\FileSystemCacheItemPool::deleteItems() + + + keys + + array + + + + {@inheritdoc} + + + + + + + saveDeferred + \Google\Auth\Cache\FileSystemCacheItemPool::saveDeferred() + + + item + + \Psr\Cache\CacheItemInterface + + + + {@inheritdoc} + + + + + + + commit + \Google\Auth\Cache\FileSystemCacheItemPool::commit() + + + {@inheritdoc} + + + + + + + cacheFilePath + \Google\Auth\Cache\FileSystemCacheItemPool::cacheFilePath() + + + key + + string + + + + + + + + + + + validKey + \Google\Auth\Cache\FileSystemCacheItemPool::validKey() + + + key + + string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + InvalidArgumentException + \Google\Auth\Cache\InvalidArgumentException + + + + + + + \InvalidArgumentException + \Psr\Cache\InvalidArgumentException + + + + + + + + + + + + + + + + + + + + + + + + + + + MemoryCacheItemPool + \Google\Auth\Cache\MemoryCacheItemPool + + Simple in-memory cache implementation. + + + + + + \Psr\Cache\CacheItemPoolInterface + + + + items + \Google\Auth\Cache\MemoryCacheItemPool::$items + + + + + + + + + + + deferredItems + \Google\Auth\Cache\MemoryCacheItemPool::$deferredItems + + + + + + + + + + + + getItem + \Google\Auth\Cache\MemoryCacheItemPool::getItem() + + + key + + mixed + + + + {@inheritdoc} + + + + + + + + getItems + \Google\Auth\Cache\MemoryCacheItemPool::getItems() + + + keys + [] + array + + + + {@inheritdoc} + + + + + + + + hasItem + \Google\Auth\Cache\MemoryCacheItemPool::hasItem() + + + key + + mixed + + + + {@inheritdoc} + + + + + + + + clear + \Google\Auth\Cache\MemoryCacheItemPool::clear() + + + {@inheritdoc} + + + + + + + + deleteItem + \Google\Auth\Cache\MemoryCacheItemPool::deleteItem() + + + key + + mixed + + + + {@inheritdoc} + + + + + + + + deleteItems + \Google\Auth\Cache\MemoryCacheItemPool::deleteItems() + + + keys + + array + + + + {@inheritdoc} + + + + + + + + save + \Google\Auth\Cache\MemoryCacheItemPool::save() + + + item + + \Psr\Cache\CacheItemInterface + + + + {@inheritdoc} + + + + + + + + saveDeferred + \Google\Auth\Cache\MemoryCacheItemPool::saveDeferred() + + + item + + \Psr\Cache\CacheItemInterface + + + + {@inheritdoc} + + + + + + + + commit + \Google\Auth\Cache\MemoryCacheItemPool::commit() + + + {@inheritdoc} + + + + + + + + isValidKey + \Google\Auth\Cache\MemoryCacheItemPool::isValidKey() + + + key + + string + + + + Determines if the provided key is valid. + + + + + + + + + + + + + + + + + Copyright 2018 Google Inc. All Rights Reserved. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + SysVCacheItemPool + \Google\Auth\Cache\SysVCacheItemPool + + SystemV shared memory based CacheItemPool implementation. + This CacheItemPool implementation can be used among multiple processes, but +it doesn't provide any locking mechanism. If multiple processes write to +this ItemPool, you have to avoid race condition manually in your code. + + + + + \Psr\Cache\CacheItemPoolInterface + + + VAR_KEY + \Google\Auth\Cache\SysVCacheItemPool::VAR_KEY + 1 + + + + + + + + + DEFAULT_PROJ + \Google\Auth\Cache\SysVCacheItemPool::DEFAULT_PROJ + 'A' + + + + + + + + + DEFAULT_SEM_PROJ + \Google\Auth\Cache\SysVCacheItemPool::DEFAULT_SEM_PROJ + 'B' + + + + + + + + + DEFAULT_MEMSIZE + \Google\Auth\Cache\SysVCacheItemPool::DEFAULT_MEMSIZE + 10000 + + + + + + + + + DEFAULT_PERM + \Google\Auth\Cache\SysVCacheItemPool::DEFAULT_PERM + 0600 + + + + + + + + + + sysvKey + \Google\Auth\Cache\SysVCacheItemPool::$sysvKey + + + + + + + + + + + items + \Google\Auth\Cache\SysVCacheItemPool::$items + + + + + + + + + + + deferredItems + \Google\Auth\Cache\SysVCacheItemPool::$deferredItems + + + + + + + + + + + options + \Google\Auth\Cache\SysVCacheItemPool::$options + + + + + + + + + + + hasLoadedItems + \Google\Auth\Cache\SysVCacheItemPool::$hasLoadedItems + false + + + + + + + + + + semId + \Google\Auth\Cache\SysVCacheItemPool::$semId + false + + + + + + + + + + lockOwnerPid + \Google\Auth\Cache\SysVCacheItemPool::$lockOwnerPid + null + + Maintain the process which is currently holding the semaphore to prevent deadlock. + + + + + + + + + __construct + \Google\Auth\Cache\SysVCacheItemPool::__construct() + + + options + [] + array + + + + Create a SystemV shared memory based CacheItemPool. + + + + + + + + getItem + \Google\Auth\Cache\SysVCacheItemPool::getItem() + + + key + + mixed + + + + + + + + + + + + + getItems + \Google\Auth\Cache\SysVCacheItemPool::getItems() + + + keys + [] + array + + + + + + + + + + + + + hasItem + \Google\Auth\Cache\SysVCacheItemPool::hasItem() + + + key + + mixed + + + + {@inheritdoc} + + + + + + + clear + \Google\Auth\Cache\SysVCacheItemPool::clear() + + + {@inheritdoc} + + + + + + + deleteItem + \Google\Auth\Cache\SysVCacheItemPool::deleteItem() + + + key + + mixed + + + + {@inheritdoc} + + + + + + + deleteItems + \Google\Auth\Cache\SysVCacheItemPool::deleteItems() + + + keys + + array + + + + {@inheritdoc} + + + + + + + save + \Google\Auth\Cache\SysVCacheItemPool::save() + + + item + + \Psr\Cache\CacheItemInterface + + + + {@inheritdoc} + + + + + + + saveDeferred + \Google\Auth\Cache\SysVCacheItemPool::saveDeferred() + + + item + + \Psr\Cache\CacheItemInterface + + + + {@inheritdoc} + + + + + + + commit + \Google\Auth\Cache\SysVCacheItemPool::commit() + + + {@inheritdoc} + + + + + + + saveCurrentItems + \Google\Auth\Cache\SysVCacheItemPool::saveCurrentItems() + + + Save the current items. + + + + + + + + loadItems + \Google\Auth\Cache\SysVCacheItemPool::loadItems() + + + Load the items from the shared memory. + + + + + + + + acquireLock + \Google\Auth\Cache\SysVCacheItemPool::acquireLock() + + + + + + + + + + releaseLock + \Google\Auth\Cache\SysVCacheItemPool::releaseLock() + + + + + + + + + + resetShm + \Google\Auth\Cache\SysVCacheItemPool::resetShm() + + + + + + + + + + attachShm + \Google\Auth\Cache\SysVCacheItemPool::attachShm() + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TypedItem + \Google\Auth\Cache\TypedItem + + A cache item. + This class will be used by MemoryCacheItemPool and SysVCacheItemPool +on PHP 8.0 and above. It is compatible with psr/cache 3.0 (PSR-6). + + + + + + \Psr\Cache\CacheItemInterface + + + + value + \Google\Auth\Cache\TypedItem::$value + + + + + + + + + + + expiration + \Google\Auth\Cache\TypedItem::$expiration + + + + + + + + + + + isHit + \Google\Auth\Cache\TypedItem::$isHit + false + + + + + + + + + + key + \Google\Auth\Cache\TypedItem::$key + + + + + + + + + + + __construct + \Google\Auth\Cache\TypedItem::__construct() + + + key + + string + + + + + + + + + + + + getKey + \Google\Auth\Cache\TypedItem::getKey() + + + {@inheritdoc} + + + + + + + get + \Google\Auth\Cache\TypedItem::get() + + + {@inheritdoc} + + + + + + + isHit + \Google\Auth\Cache\TypedItem::isHit() + + + {@inheritdoc} + + + + + + + set + \Google\Auth\Cache\TypedItem::set() + + + value + + mixed + + + + {@inheritdoc} + + + + + + + expiresAt + \Google\Auth\Cache\TypedItem::expiresAt() + + + expiration + + mixed + + + + {@inheritdoc} + + + + + + + expiresAfter + \Google\Auth\Cache\TypedItem::expiresAfter() + + + time + + mixed + + + + {@inheritdoc} + + + + + + + isValidExpiration + \Google\Auth\Cache\TypedItem::isValidExpiration() + + + expiration + + mixed + + + + Determines if an expiration is valid based on the rules defined by PSR6. + + + + + + + + + currentTime + \Google\Auth\Cache\TypedItem::currentTime() + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CacheTrait + \Google\Auth\CacheTrait + + + + + + + + maxKeyLength + \Google\Auth\CacheTrait::$maxKeyLength + 64 + + + + + + + + + + cacheConfig + \Google\Auth\CacheTrait::$cacheConfig + + + + + + + + + + + cache + \Google\Auth\CacheTrait::$cache + + + + + + + + + + + + getCachedValue + \Google\Auth\CacheTrait::getCachedValue() + + + k + + mixed + + + + Gets the cached value if it is present in the cache when that is +available. + + + + + + + + + setCachedValue + \Google\Auth\CacheTrait::setCachedValue() + + + k + + mixed + + + + v + + mixed + + + + Saves the value in the cache when that is available. + + + + + + + + + + getFullCacheKey + \Google\Auth\CacheTrait::getFullCacheKey() + + + key + + null|string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AppIdentityCredentials + \Google\Auth\Credentials\AppIdentityCredentials + + CredentialsLoader contains the behaviour used to locate and find default +credentials files on the file system. + + + + + + \Google\Auth\CredentialsLoader + \Google\Auth\SignBlobInterface + \Google\Auth\ProjectIdProviderInterface + + + TOKEN_CREDENTIAL_URI + \Google\Auth\CredentialsLoader::TOKEN_CREDENTIAL_URI + 'https://oauth2.googleapis.com/token' + \Google\Auth\CredentialsLoader + + + + + + + + ENV_VAR + \Google\Auth\CredentialsLoader::ENV_VAR + 'GOOGLE_APPLICATION_CREDENTIALS' + \Google\Auth\CredentialsLoader + + + + + + + + QUOTA_PROJECT_ENV_VAR + \Google\Auth\CredentialsLoader::QUOTA_PROJECT_ENV_VAR + 'GOOGLE_CLOUD_QUOTA_PROJECT' + \Google\Auth\CredentialsLoader + + + + + + + + WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::WELL_KNOWN_PATH + 'gcloud/application_default_credentials.json' + \Google\Auth\CredentialsLoader + + + + + + + + NON_WINDOWS_WELL_KNOWN_PATH_BASE + \Google\Auth\CredentialsLoader::NON_WINDOWS_WELL_KNOWN_PATH_BASE + '.config' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::MTLS_WELL_KNOWN_PATH + '.secureConnect/context_aware_metadata.json' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_CERT_ENV_VAR + \Google\Auth\CredentialsLoader::MTLS_CERT_ENV_VAR + 'GOOGLE_API_USE_CLIENT_CERTIFICATE' + \Google\Auth\CredentialsLoader + + + + + + + + + lastReceivedToken + \Google\Auth\Credentials\AppIdentityCredentials::$lastReceivedToken + + + Result of fetchAuthToken. + + + + + + + + scope + \Google\Auth\Credentials\AppIdentityCredentials::$scope + + + Array of OAuth2 scopes to be requested. + + + + + + + + clientName + \Google\Auth\Credentials\AppIdentityCredentials::$clientName + + + + + + + + + + + + __construct + \Google\Auth\Credentials\AppIdentityCredentials::__construct() + + + scope + [] + string|string[] + + + + + + + + + + + + onAppEngine + \Google\Auth\Credentials\AppIdentityCredentials::onAppEngine() + + + Determines if this an App Engine instance, by accessing the +SERVER_SOFTWARE environment variable (prod) or the APPENGINE_RUNTIME +environment variable (dev). + + + + + + + + fetchAuthToken + \Google\Auth\Credentials\AppIdentityCredentials::fetchAuthToken() + + + httpHandler + null + callable|null + + + + Implements FetchAuthTokenInterface#fetchAuthToken. + Fetches the auth tokens using the AppIdentityService if available. +As the AppIdentityService uses protobufs to fetch the access token, +the GuzzleHttp\ClientInterface instance passed in will not be used. + + + + + + + + signBlob + \Google\Auth\Credentials\AppIdentityCredentials::signBlob() + + + stringToSign + + string + + + + forceOpenSsl + false + bool + + + + Sign a string using AppIdentityService. + + + + + + + + + + + getProjectId + \Google\Auth\Credentials\AppIdentityCredentials::getProjectId() + + + httpHandler + null + callable|null + + + + Get the project ID from AppIdentityService. + Returns null if AppIdentityService is unavailable. + + + + + + + + getClientName + \Google\Auth\Credentials\AppIdentityCredentials::getClientName() + + + httpHandler + null + callable|null + + + + Get the client name from AppIdentityService. + Subsequent calls to this method will return a cached value. + + + + + + + + + getLastReceivedToken + \Google\Auth\Credentials\AppIdentityCredentials::getLastReceivedToken() + + + Returns an associative array with the token and +expiration time. + + + + + + + + getCacheKey + \Google\Auth\Credentials\AppIdentityCredentials::getCacheKey() + + + Caching is handled by the underlying AppIdentityService, return empty string +to prevent caching. + + + + + + + + checkAppEngineContext + \Google\Auth\Credentials\AppIdentityCredentials::checkAppEngineContext() + + + + + + + + + + + getUpdateMetadataFunc + \Google\Auth\UpdateMetadataTrait::getUpdateMetadataFunc() + + \Google\Auth\UpdateMetadataTrait + export a callback function which updates runtime metadata. + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataTrait::updateMetadata() + + \Google\Auth\UpdateMetadataTrait + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + fromEnv + \Google\Auth\CredentialsLoader::fromEnv() + + \Google\Auth\CredentialsLoader + Load a JSON key from the path specified in the environment. + Load a JSON key from the path specified in the environment +variable GOOGLE_APPLICATION_CREDENTIALS. Return null if +GOOGLE_APPLICATION_CREDENTIALS is not specified. + + + + + + + fromWellKnownFile + \Google\Auth\CredentialsLoader::fromWellKnownFile() + + \Google\Auth\CredentialsLoader + Load a JSON key from a well known path. + The well known path is OS dependent: + +* windows: %APPDATA%/gcloud/application_default_credentials.json +* others: $HOME/.config/gcloud/application_default_credentials.json + +If the file does not exist, this returns null. + + + + + + + makeCredentials + \Google\Auth\CredentialsLoader::makeCredentials() + + \Google\Auth\CredentialsLoader + scope + + string|string[] + + + + jsonKey + + array + + + + defaultScope + null + string|string[] + + + + Create a new Credentials instance. + + + + + + + + + + + + + makeHttpClient + \Google\Auth\CredentialsLoader::makeHttpClient() + + \Google\Auth\CredentialsLoader + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + httpClientOptions + [] + array + + + + httpHandler + null + callable|null + + + + tokenCallback + null + callable|null + + + + Create an authorized HTTP Client from an instance of FetchAuthTokenInterface. + + + + + + + + + + + + makeInsecureCredentials + \Google\Auth\CredentialsLoader::makeInsecureCredentials() + + \Google\Auth\CredentialsLoader + Create a new instance of InsecureCredentials. + + + + + + + + quotaProjectFromEnv + \Google\Auth\CredentialsLoader::quotaProjectFromEnv() + + \Google\Auth\CredentialsLoader + Fetch a quota project from the environment variable +GOOGLE_CLOUD_QUOTA_PROJECT. Return null if +GOOGLE_CLOUD_QUOTA_PROJECT is not specified. + + + + + + + + getDefaultClientCertSource + \Google\Auth\CredentialsLoader::getDefaultClientCertSource() + + \Google\Auth\CredentialsLoader + Gets a callable which returns the default device certification. + + + + + + + + + shouldLoadClientCertSource + \Google\Auth\CredentialsLoader::shouldLoadClientCertSource() + + \Google\Auth\CredentialsLoader + Determines whether or not the default device certificate should be loaded. + + + + + + + + getUniverseDomain + \Google\Auth\CredentialsLoader::getUniverseDomain() + + \Google\Auth\CredentialsLoader + Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ExternalAccountCredentials + \Google\Auth\Credentials\ExternalAccountCredentials + + **IMPORTANT**: +This class does not validate the credential configuration. A security +risk occurs when a credential configuration configured with malicious urls +is used. + When the credential configuration is accepted from an +untrusted source, you should validate it before creating this class. + + + + + + \Google\Auth\FetchAuthTokenInterface + \Google\Auth\UpdateMetadataInterface + \Google\Auth\GetQuotaProjectInterface + \Google\Auth\GetUniverseDomainInterface + \Google\Auth\ProjectIdProviderInterface + + + EXTERNAL_ACCOUNT_TYPE + \Google\Auth\Credentials\ExternalAccountCredentials::EXTERNAL_ACCOUNT_TYPE + 'external_account' + + + + + + + + + CLOUD_RESOURCE_MANAGER_URL + \Google\Auth\Credentials\ExternalAccountCredentials::CLOUD_RESOURCE_MANAGER_URL + 'https://cloudresourcemanager.UNIVERSE_DOMAIN/v1/projects/%s' + + + + + + + + + + auth + \Google\Auth\Credentials\ExternalAccountCredentials::$auth + + + + + + + + + + quotaProject + \Google\Auth\Credentials\ExternalAccountCredentials::$quotaProject + + + + + + + + + + serviceAccountImpersonationUrl + \Google\Auth\Credentials\ExternalAccountCredentials::$serviceAccountImpersonationUrl + + + + + + + + + + workforcePoolUserProject + \Google\Auth\Credentials\ExternalAccountCredentials::$workforcePoolUserProject + + + + + + + + + + projectId + \Google\Auth\Credentials\ExternalAccountCredentials::$projectId + + + + + + + + + + lastImpersonatedAccessToken + \Google\Auth\Credentials\ExternalAccountCredentials::$lastImpersonatedAccessToken + + + + + + + + + + + universeDomain + \Google\Auth\Credentials\ExternalAccountCredentials::$universeDomain + + + + + + + + + + + __construct + \Google\Auth\Credentials\ExternalAccountCredentials::__construct() + + + scope + + string|string[] + + + + jsonKey + + array + + + + + + + + + + + + + buildCredentialSource + \Google\Auth\Credentials\ExternalAccountCredentials::buildCredentialSource() + + + jsonKey + + array + + + + + + + + + + + + getImpersonatedAccessToken + \Google\Auth\Credentials\ExternalAccountCredentials::getImpersonatedAccessToken() + + + stsToken + + string + + + + httpHandler + null + callable|null + + + + + + + + + + + + + + fetchAuthToken + \Google\Auth\Credentials\ExternalAccountCredentials::fetchAuthToken() + + + httpHandler + null + callable|null + + + + headers + [] + array + + + + Fetches the auth tokens based on the current state. + + + + + + + + + + getCacheKey + \Google\Auth\Credentials\ExternalAccountCredentials::getCacheKey() + + + Get the cache token key for the credentials. + The cache token key format depends on the type of source +The format for the cache key one of the following: +FetcherCacheKey.Scope.[ServiceAccount].[TokenType].[WorkforcePoolUserProject] +FetcherCacheKey.Audience.[ServiceAccount].[TokenType].[WorkforcePoolUserProject] + + + + + + + getLastReceivedToken + \Google\Auth\Credentials\ExternalAccountCredentials::getLastReceivedToken() + + + Returns an associative array with the token and +expiration time. + + + + + + + getQuotaProject + \Google\Auth\Credentials\ExternalAccountCredentials::getQuotaProject() + + + Get the quota project used for this API request + + + + + + + + getUniverseDomain + \Google\Auth\Credentials\ExternalAccountCredentials::getUniverseDomain() + + + Get the universe domain used for this API request + + + + + + + + getProjectId + \Google\Auth\Credentials\ExternalAccountCredentials::getProjectId() + + + httpHandler + null + callable|null + + + + accessToken + null + string|null + + + + Get the project ID. + + + + + + + + + + getProjectNumber + \Google\Auth\Credentials\ExternalAccountCredentials::getProjectNumber() + + + + + + + + + + isWorkforcePool + \Google\Auth\Credentials\ExternalAccountCredentials::isWorkforcePool() + + + + + + + + + + getUpdateMetadataFunc + \Google\Auth\UpdateMetadataTrait::getUpdateMetadataFunc() + + \Google\Auth\UpdateMetadataTrait + export a callback function which updates runtime metadata. + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataTrait::updateMetadata() + + \Google\Auth\UpdateMetadataTrait + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + + + + Tag "@return" with body "@@return ?string;" has error + + + + + + + + + + + + + + + + + + + + GCECredentials + \Google\Auth\Credentials\GCECredentials + + GCECredentials supports authorization on Google Compute Engine. + It can be used to authorize requests using the AuthTokenMiddleware, but will +only succeed if being run on GCE: + + use Google\Auth\Credentials\GCECredentials; + use Google\Auth\Middleware\AuthTokenMiddleware; + use GuzzleHttp\Client; + use GuzzleHttp\HandlerStack; + + $gce = new GCECredentials(); + $middleware = new AuthTokenMiddleware($gce); + $stack = HandlerStack::create(); + $stack->push($middleware); + + $client = new Client([ + 'handler' => $stack, + 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', + 'auth' => 'google_auth' + ]); + + $res = $client->get('myproject/taskqueues/myqueue'); + + + + \Google\Auth\CredentialsLoader + \Google\Auth\SignBlobInterface + \Google\Auth\ProjectIdProviderInterface + \Google\Auth\GetQuotaProjectInterface + + + cacheKey + \Google\Auth\Credentials\GCECredentials::cacheKey + 'GOOGLE_AUTH_PHP_GCE' + + + + + + + + + METADATA_IP + \Google\Auth\Credentials\GCECredentials::METADATA_IP + '169.254.169.254' + + The metadata IP address on appengine instances. + The IP is used instead of the domain 'metadata' to avoid slow responses +when not on Compute Engine. + + + + + + TOKEN_URI_PATH + \Google\Auth\Credentials\GCECredentials::TOKEN_URI_PATH + 'v1/instance/service-accounts/default/token' + + The metadata path of the default token. + + + + + + + ID_TOKEN_URI_PATH + \Google\Auth\Credentials\GCECredentials::ID_TOKEN_URI_PATH + 'v1/instance/service-accounts/default/identity' + + The metadata path of the default id token. + + + + + + + CLIENT_ID_URI_PATH + \Google\Auth\Credentials\GCECredentials::CLIENT_ID_URI_PATH + 'v1/instance/service-accounts/default/email' + + The metadata path of the client ID. + + + + + + + PROJECT_ID_URI_PATH + \Google\Auth\Credentials\GCECredentials::PROJECT_ID_URI_PATH + 'v1/project/project-id' + + The metadata path of the project ID. + + + + + + + UNIVERSE_DOMAIN_URI_PATH + \Google\Auth\Credentials\GCECredentials::UNIVERSE_DOMAIN_URI_PATH + 'v1/universe/universe-domain' + + The metadata path of the project ID. + + + + + + + FLAVOR_HEADER + \Google\Auth\Credentials\GCECredentials::FLAVOR_HEADER + 'Metadata-Flavor' + + The header whose presence indicates GCE presence. + + + + + + + GKE_PRODUCT_NAME_FILE + \Google\Auth\Credentials\GCECredentials::GKE_PRODUCT_NAME_FILE + '/sys/class/dmi/id/product_name' + + The Linux file which contains the product name. + + + + + + + WINDOWS_REGISTRY_KEY_PATH + \Google\Auth\Credentials\GCECredentials::WINDOWS_REGISTRY_KEY_PATH + 'HKEY_LOCAL_MACHINE\SYSTEM\HardwareConfig\Current\\' + + The Windows Registry key path to the product name + + + + + + + WINDOWS_REGISTRY_KEY_NAME + \Google\Auth\Credentials\GCECredentials::WINDOWS_REGISTRY_KEY_NAME + 'SystemProductName' + + The Windows registry key name for the product name + + + + + + + PRODUCT_NAME + \Google\Auth\Credentials\GCECredentials::PRODUCT_NAME + 'Google' + + The Name of the product expected from the windows registry + + + + + + + CRED_TYPE + \Google\Auth\Credentials\GCECredentials::CRED_TYPE + 'mds' + + + + + + + + + MAX_COMPUTE_PING_TRIES + \Google\Auth\Credentials\GCECredentials::MAX_COMPUTE_PING_TRIES + 3 + + Note: the explicit `timeout` and `tries` below is a workaround. The underlying +issue is that resolving an unknown host on some networks will take +20-30 seconds; making this timeout short fixes the issue, but +could lead to false negatives in the event that we are on GCE, but +the metadata resolution was particularly slow. The latter case is +"unlikely" since the expected 4-nines time is about 0.5 seconds. + This allows us to limit the total ping maximum timeout to 1.5 seconds +for developer desktop scenarios. + + + + + + COMPUTE_PING_CONNECTION_TIMEOUT_S + \Google\Auth\Credentials\GCECredentials::COMPUTE_PING_CONNECTION_TIMEOUT_S + 0.5 + + + + + + + + + TOKEN_CREDENTIAL_URI + \Google\Auth\CredentialsLoader::TOKEN_CREDENTIAL_URI + 'https://oauth2.googleapis.com/token' + \Google\Auth\CredentialsLoader + + + + + + + + ENV_VAR + \Google\Auth\CredentialsLoader::ENV_VAR + 'GOOGLE_APPLICATION_CREDENTIALS' + \Google\Auth\CredentialsLoader + + + + + + + + QUOTA_PROJECT_ENV_VAR + \Google\Auth\CredentialsLoader::QUOTA_PROJECT_ENV_VAR + 'GOOGLE_CLOUD_QUOTA_PROJECT' + \Google\Auth\CredentialsLoader + + + + + + + + WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::WELL_KNOWN_PATH + 'gcloud/application_default_credentials.json' + \Google\Auth\CredentialsLoader + + + + + + + + NON_WINDOWS_WELL_KNOWN_PATH_BASE + \Google\Auth\CredentialsLoader::NON_WINDOWS_WELL_KNOWN_PATH_BASE + '.config' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::MTLS_WELL_KNOWN_PATH + '.secureConnect/context_aware_metadata.json' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_CERT_ENV_VAR + \Google\Auth\CredentialsLoader::MTLS_CERT_ENV_VAR + 'GOOGLE_API_USE_CLIENT_CERTIFICATE' + \Google\Auth\CredentialsLoader + + + + + + + + + hasCheckedOnGce + \Google\Auth\Credentials\GCECredentials::$hasCheckedOnGce + false + + Flag used to ensure that the onGCE test is only done once;. + + + + + + + + isOnGce + \Google\Auth\Credentials\GCECredentials::$isOnGce + false + + Flag that stores the value of the onGCE check. + + + + + + + + lastReceivedToken + \Google\Auth\Credentials\GCECredentials::$lastReceivedToken + + + Result of fetchAuthToken. + + + + + + + + clientName + \Google\Auth\Credentials\GCECredentials::$clientName + + + + + + + + + + + projectId + \Google\Auth\Credentials\GCECredentials::$projectId + + + + + + + + + + + tokenUri + \Google\Auth\Credentials\GCECredentials::$tokenUri + + + + + + + + + + + targetAudience + \Google\Auth\Credentials\GCECredentials::$targetAudience + + + + + + + + + + + quotaProject + \Google\Auth\Credentials\GCECredentials::$quotaProject + + + + + + + + + + + serviceAccountIdentity + \Google\Auth\Credentials\GCECredentials::$serviceAccountIdentity + + + + + + + + + + + universeDomain + \Google\Auth\Credentials\GCECredentials::$universeDomain + + + + + + + + + + + iam + \Google\Auth\IamSignerTrait::$iam + + \Google\Auth\IamSignerTrait + + + + + + + + + + __construct + \Google\Auth\Credentials\GCECredentials::__construct() + + + iam + null + \Google\Auth\Iam|null + + + + scope + null + string|string[] + + + + targetAudience + null + string + + + + quotaProject + null + string + + + + serviceAccountIdentity + null + string + + + + universeDomain + null + string|null + + + + + + + + + + + + + + + + + getTokenUri + \Google\Auth\Credentials\GCECredentials::getTokenUri() + + + serviceAccountIdentity + null + string + + + + The full uri for accessing the default token. + + + + + + + + + getClientNameUri + \Google\Auth\Credentials\GCECredentials::getClientNameUri() + + + serviceAccountIdentity + null + string + + + + The full uri for accessing the default service account. + + + + + + + + + getIdTokenUri + \Google\Auth\Credentials\GCECredentials::getIdTokenUri() + + + serviceAccountIdentity + null + string + + + + The full uri for accesesing the default identity token. + + + + + + + + + getProjectIdUri + \Google\Auth\Credentials\GCECredentials::getProjectIdUri() + + + The full uri for accessing the default project ID. + + + + + + + + getUniverseDomainUri + \Google\Auth\Credentials\GCECredentials::getUniverseDomainUri() + + + The full uri for accessing the default universe domain. + + + + + + + + onAppEngineFlexible + \Google\Auth\Credentials\GCECredentials::onAppEngineFlexible() + + + Determines if this an App Engine Flexible instance, by accessing the +GAE_INSTANCE environment variable. + + + + + + + + onGce + \Google\Auth\Credentials\GCECredentials::onGce() + + + httpHandler + null + callable|null + + + + Determines if this a GCE instance, by accessing the expected metadata +host. + If $httpHandler is not specified a the default HttpHandler is used. + + + + + + + + detectResidencyLinux + \Google\Auth\Credentials\GCECredentials::detectResidencyLinux() + + + productNameFile + + string + + + + + + + + + + + detectResidencyWindows + \Google\Auth\Credentials\GCECredentials::detectResidencyWindows() + + + registryProductKey + + string + + + + + + + + + + + fetchAuthToken + \Google\Auth\Credentials\GCECredentials::fetchAuthToken() + + + httpHandler + null + callable|null + + + + headers + [] + array + + + + Implements FetchAuthTokenInterface#fetchAuthToken. + Fetches the auth tokens from the GCE metadata host if it is available. +If $httpHandler is not specified a the default HttpHandler is used. + + + + + + + + + + getCacheKey + \Google\Auth\Credentials\GCECredentials::getCacheKey() + + + Returns the Cache Key for the credential token. + The format for the cache key is: +TokenURI + + + + + + + getLastReceivedToken + \Google\Auth\Credentials\GCECredentials::getLastReceivedToken() + + + Returns an associative array with the token and +expiration time. + + + + + + + + getClientName + \Google\Auth\Credentials\GCECredentials::getClientName() + + + httpHandler + null + callable|null + + + + Get the client name from GCE metadata. + Subsequent calls will return a cached value. + + + + + + + + getProjectId + \Google\Auth\Credentials\GCECredentials::getProjectId() + + + httpHandler + null + callable|null + + + + Fetch the default Project ID from compute engine. + Returns null if called outside GCE. + + + + + + + + getUniverseDomain + \Google\Auth\Credentials\GCECredentials::getUniverseDomain() + + + httpHandler + null + callable|null + + + + Fetch the default universe domain from the metadata server. + + + + + + + + + getFromMetadata + \Google\Auth\Credentials\GCECredentials::getFromMetadata() + + + httpHandler + + callable + + + + uri + + string + + + + headers + [] + array + + + + Fetch the value of a GCE metadata server URI. + + + + + + + + + + + getQuotaProject + \Google\Auth\Credentials\GCECredentials::getQuotaProject() + + + Get the quota project used for this API request + + + + + + + + setIsOnGce + \Google\Auth\Credentials\GCECredentials::setIsOnGce() + + + isOnGce + + bool + + + + Set whether or not we've already checked the GCE environment. + + + + + + + + + getCredType + \Google\Auth\Credentials\GCECredentials::getCredType() + + + + + + + + + + getUpdateMetadataFunc + \Google\Auth\UpdateMetadataTrait::getUpdateMetadataFunc() + + \Google\Auth\UpdateMetadataTrait + export a callback function which updates runtime metadata. + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataTrait::updateMetadata() + + \Google\Auth\UpdateMetadataTrait + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + fromEnv + \Google\Auth\CredentialsLoader::fromEnv() + + \Google\Auth\CredentialsLoader + Load a JSON key from the path specified in the environment. + Load a JSON key from the path specified in the environment +variable GOOGLE_APPLICATION_CREDENTIALS. Return null if +GOOGLE_APPLICATION_CREDENTIALS is not specified. + + + + + + + fromWellKnownFile + \Google\Auth\CredentialsLoader::fromWellKnownFile() + + \Google\Auth\CredentialsLoader + Load a JSON key from a well known path. + The well known path is OS dependent: + +* windows: %APPDATA%/gcloud/application_default_credentials.json +* others: $HOME/.config/gcloud/application_default_credentials.json + +If the file does not exist, this returns null. + + + + + + + makeCredentials + \Google\Auth\CredentialsLoader::makeCredentials() + + \Google\Auth\CredentialsLoader + scope + + string|string[] + + + + jsonKey + + array + + + + defaultScope + null + string|string[] + + + + Create a new Credentials instance. + + + + + + + + + + + + + makeHttpClient + \Google\Auth\CredentialsLoader::makeHttpClient() + + \Google\Auth\CredentialsLoader + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + httpClientOptions + [] + array + + + + httpHandler + null + callable|null + + + + tokenCallback + null + callable|null + + + + Create an authorized HTTP Client from an instance of FetchAuthTokenInterface. + + + + + + + + + + + + makeInsecureCredentials + \Google\Auth\CredentialsLoader::makeInsecureCredentials() + + \Google\Auth\CredentialsLoader + Create a new instance of InsecureCredentials. + + + + + + + + quotaProjectFromEnv + \Google\Auth\CredentialsLoader::quotaProjectFromEnv() + + \Google\Auth\CredentialsLoader + Fetch a quota project from the environment variable +GOOGLE_CLOUD_QUOTA_PROJECT. Return null if +GOOGLE_CLOUD_QUOTA_PROJECT is not specified. + + + + + + + + getDefaultClientCertSource + \Google\Auth\CredentialsLoader::getDefaultClientCertSource() + + \Google\Auth\CredentialsLoader + Gets a callable which returns the default device certification. + + + + + + + + + shouldLoadClientCertSource + \Google\Auth\CredentialsLoader::shouldLoadClientCertSource() + + \Google\Auth\CredentialsLoader + Determines whether or not the default device certificate should be loaded. + + + + + + + + getUniverseDomain + \Google\Auth\CredentialsLoader::getUniverseDomain() + + \Google\Auth\CredentialsLoader + Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain. + + + + + + + + signBlob + \Google\Auth\IamSignerTrait::signBlob() + + \Google\Auth\IamSignerTrait + stringToSign + + string + + + + forceOpenSsl + false + bool + + + + accessToken + null + string + + + + Sign a string using the default service account private key. + This implementation uses IAM's signBlob API. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + IAMCredentials + \Google\Auth\Credentials\IAMCredentials + + Authenticates requests using IAM credentials. + + + + + + + + SELECTOR_KEY + \Google\Auth\Credentials\IAMCredentials::SELECTOR_KEY + 'x-goog-iam-authority-selector' + + + + + + + + + TOKEN_KEY + \Google\Auth\Credentials\IAMCredentials::TOKEN_KEY + 'x-goog-iam-authorization-token' + + + + + + + + + + selector + \Google\Auth\Credentials\IAMCredentials::$selector + + + + + + + + + + + token + \Google\Auth\Credentials\IAMCredentials::$token + + + + + + + + + + + + __construct + \Google\Auth\Credentials\IAMCredentials::__construct() + + + selector + + string + + + + token + + string + + + + + + + + + + + + + getUpdateMetadataFunc + \Google\Auth\Credentials\IAMCredentials::getUpdateMetadataFunc() + + + export a callback function which updates runtime metadata. + + + + + + + + updateMetadata + \Google\Auth\Credentials\IAMCredentials::updateMetadata() + + + metadata + + array + + + + unusedAuthUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the appropriate header metadata. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ImpersonatedServiceAccountCredentials + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials + + **IMPORTANT**: +This class does not validate the credential configuration. A security +risk occurs when a credential configuration configured with malicious urls +is used. + When the credential configuration is accepted from an +untrusted source, you should validate it before creating this class. + + + + + \Google\Auth\CredentialsLoader + \Google\Auth\SignBlobInterface + \Google\Auth\GetUniverseDomainInterface + + + CRED_TYPE + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::CRED_TYPE + 'imp' + + + + + + + + + IAM_SCOPE + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::IAM_SCOPE + 'https://www.googleapis.com/auth/iam' + + + + + + + + + ID_TOKEN_IMPERSONATION_URL + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::ID_TOKEN_IMPERSONATION_URL + 'https://iamcredentials.UNIVERSE_DOMAIN/v1/projects/-/serviceAccounts/%s:generateIdToken' + + + + + + + + + TOKEN_CREDENTIAL_URI + \Google\Auth\CredentialsLoader::TOKEN_CREDENTIAL_URI + 'https://oauth2.googleapis.com/token' + \Google\Auth\CredentialsLoader + + + + + + + + ENV_VAR + \Google\Auth\CredentialsLoader::ENV_VAR + 'GOOGLE_APPLICATION_CREDENTIALS' + \Google\Auth\CredentialsLoader + + + + + + + + QUOTA_PROJECT_ENV_VAR + \Google\Auth\CredentialsLoader::QUOTA_PROJECT_ENV_VAR + 'GOOGLE_CLOUD_QUOTA_PROJECT' + \Google\Auth\CredentialsLoader + + + + + + + + WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::WELL_KNOWN_PATH + 'gcloud/application_default_credentials.json' + \Google\Auth\CredentialsLoader + + + + + + + + NON_WINDOWS_WELL_KNOWN_PATH_BASE + \Google\Auth\CredentialsLoader::NON_WINDOWS_WELL_KNOWN_PATH_BASE + '.config' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::MTLS_WELL_KNOWN_PATH + '.secureConnect/context_aware_metadata.json' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_CERT_ENV_VAR + \Google\Auth\CredentialsLoader::MTLS_CERT_ENV_VAR + 'GOOGLE_API_USE_CLIENT_CERTIFICATE' + \Google\Auth\CredentialsLoader + + + + + + + + + impersonatedServiceAccountName + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::$impersonatedServiceAccountName + + + + + + + + + + + sourceCredentials + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::$sourceCredentials + + + + + + + + + + serviceAccountImpersonationUrl + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::$serviceAccountImpersonationUrl + + + + + + + + + + delegates + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::$delegates + + + + + + + + + + + targetScope + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::$targetScope + + + + + + + + + + + lifetime + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::$lifetime + + + + + + + + + + lastReceivedToken + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::$lastReceivedToken + null + + + + + + + + + + targetAudience + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::$targetAudience + null + + + + + + + + + iam + \Google\Auth\IamSignerTrait::$iam + + \Google\Auth\IamSignerTrait + + + + + + + + + maxKeyLength + \Google\Auth\CacheTrait::$maxKeyLength + 64 + \Google\Auth\CacheTrait + + + + + + + + + cacheConfig + \Google\Auth\CacheTrait::$cacheConfig + + \Google\Auth\CacheTrait + + + + + + + + + cache + \Google\Auth\CacheTrait::$cache + + \Google\Auth\CacheTrait + + + + + + + + + + __construct + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::__construct() + + + scope + + string|string[]|null + + + + jsonKey + + string|array + + + + targetAudience + null + string|null + + + + defaultScope + null + string|string[]|null + + + + Instantiate an instance of ImpersonatedServiceAccountCredentials from a credentials file that +has be created with the --impersonate-service-account flag. + + + + + + + + + + + getImpersonatedServiceAccountNameFromUrl + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::getImpersonatedServiceAccountNameFromUrl() + + + serviceAccountImpersonationUrl + + mixed + + + + Helper function for extracting the Server Account Name from the URL saved in the account +credentials file. + + + + + + + + + getClientName + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::getClientName() + + + unusedHttpHandler + null + callable|null + + + + Get the client name from the keyfile + In this implementation, it will return the issuers email from the oauth token. + + + + + + + + fetchAuthToken + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::fetchAuthToken() + + + httpHandler + null + callable|null + + + + Fetches the auth tokens based on the current state. + + + + + + + + + getCacheKey + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::getCacheKey() + + + Returns the Cache Key for the credentials +The cache key is the same as the UserRefreshCredentials class + + + + + + + + getLastReceivedToken + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::getLastReceivedToken() + + + Returns an associative array with the token and +expiration time. + + + + + + + + getCredType + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::getCredType() + + + + + + + + + + isIdTokenRequest + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::isIdTokenRequest() + + + + + + + + + + getUniverseDomain + \Google\Auth\Credentials\ImpersonatedServiceAccountCredentials::getUniverseDomain() + + + Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain. + + + + + + + getUpdateMetadataFunc + \Google\Auth\UpdateMetadataTrait::getUpdateMetadataFunc() + + \Google\Auth\UpdateMetadataTrait + export a callback function which updates runtime metadata. + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataTrait::updateMetadata() + + \Google\Auth\UpdateMetadataTrait + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + fromEnv + \Google\Auth\CredentialsLoader::fromEnv() + + \Google\Auth\CredentialsLoader + Load a JSON key from the path specified in the environment. + Load a JSON key from the path specified in the environment +variable GOOGLE_APPLICATION_CREDENTIALS. Return null if +GOOGLE_APPLICATION_CREDENTIALS is not specified. + + + + + + + fromWellKnownFile + \Google\Auth\CredentialsLoader::fromWellKnownFile() + + \Google\Auth\CredentialsLoader + Load a JSON key from a well known path. + The well known path is OS dependent: + +* windows: %APPDATA%/gcloud/application_default_credentials.json +* others: $HOME/.config/gcloud/application_default_credentials.json + +If the file does not exist, this returns null. + + + + + + + makeCredentials + \Google\Auth\CredentialsLoader::makeCredentials() + + \Google\Auth\CredentialsLoader + scope + + string|string[] + + + + jsonKey + + array + + + + defaultScope + null + string|string[] + + + + Create a new Credentials instance. + + + + + + + + + + + + + makeHttpClient + \Google\Auth\CredentialsLoader::makeHttpClient() + + \Google\Auth\CredentialsLoader + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + httpClientOptions + [] + array + + + + httpHandler + null + callable|null + + + + tokenCallback + null + callable|null + + + + Create an authorized HTTP Client from an instance of FetchAuthTokenInterface. + + + + + + + + + + + + makeInsecureCredentials + \Google\Auth\CredentialsLoader::makeInsecureCredentials() + + \Google\Auth\CredentialsLoader + Create a new instance of InsecureCredentials. + + + + + + + + quotaProjectFromEnv + \Google\Auth\CredentialsLoader::quotaProjectFromEnv() + + \Google\Auth\CredentialsLoader + Fetch a quota project from the environment variable +GOOGLE_CLOUD_QUOTA_PROJECT. Return null if +GOOGLE_CLOUD_QUOTA_PROJECT is not specified. + + + + + + + + getDefaultClientCertSource + \Google\Auth\CredentialsLoader::getDefaultClientCertSource() + + \Google\Auth\CredentialsLoader + Gets a callable which returns the default device certification. + + + + + + + + + shouldLoadClientCertSource + \Google\Auth\CredentialsLoader::shouldLoadClientCertSource() + + \Google\Auth\CredentialsLoader + Determines whether or not the default device certificate should be loaded. + + + + + + + + getUniverseDomain + \Google\Auth\CredentialsLoader::getUniverseDomain() + + \Google\Auth\CredentialsLoader + Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain. + + + + + + + + signBlob + \Google\Auth\IamSignerTrait::signBlob() + + \Google\Auth\IamSignerTrait + stringToSign + + string + + + + forceOpenSsl + false + bool + + + + accessToken + null + string + + + + Sign a string using the default service account private key. + This implementation uses IAM's signBlob API. + + + + + + + + + + + + getCachedValue + \Google\Auth\CacheTrait::getCachedValue() + + \Google\Auth\CacheTrait + k + + mixed + + + + Gets the cached value if it is present in the cache when that is +available. + + + + + + + + + setCachedValue + \Google\Auth\CacheTrait::setCachedValue() + + \Google\Auth\CacheTrait + k + + mixed + + + + v + + mixed + + + + Saves the value in the cache when that is available. + + + + + + + + + + getFullCacheKey + \Google\Auth\CacheTrait::getFullCacheKey() + + \Google\Auth\CacheTrait + key + + null|string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + InsecureCredentials + \Google\Auth\Credentials\InsecureCredentials + + Provides a set of credentials that will always return an empty access token. + This is useful for APIs which do not require authentication, for local +service emulators, and for testing. + + + + + \Google\Auth\FetchAuthTokenInterface + + + + token + \Google\Auth\Credentials\InsecureCredentials::$token + ['access_token' => ''] + + + + + + + + + + + fetchAuthToken + \Google\Auth\Credentials\InsecureCredentials::fetchAuthToken() + + + httpHandler + null + callable|null + + + + Fetches the auth token. In this case it returns an empty string. + + + + + + + + + getCacheKey + \Google\Auth\Credentials\InsecureCredentials::getCacheKey() + + + Returns the cache key. In this case it returns a null value, disabling +caching. + + + + + + + + getLastReceivedToken + \Google\Auth\Credentials\InsecureCredentials::getLastReceivedToken() + + + Fetches the last received token. In this case, it returns the same empty string +auth token. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ServiceAccountCredentials + \Google\Auth\Credentials\ServiceAccountCredentials + + ServiceAccountCredentials supports authorization using a Google service +account. + (cf https://developers.google.com/accounts/docs/OAuth2ServiceAccount) + +It's initialized using the json key file that's downloadable from developer +console, which should contain a private_key and client_email fields that it +uses. + +Use it with AuthTokenMiddleware to authorize http requests: + + use Google\Auth\Credentials\ServiceAccountCredentials; + use Google\Auth\Middleware\AuthTokenMiddleware; + use GuzzleHttp\Client; + use GuzzleHttp\HandlerStack; + + $sa = new ServiceAccountCredentials( + 'https://www.googleapis.com/auth/taskqueue', + '/path/to/your/json/key_file.json' + ); + $middleware = new AuthTokenMiddleware($sa); + $stack = HandlerStack::create(); + $stack->push($middleware); + + $client = new Client([ + 'handler' => $stack, + 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', + 'auth' => 'google_auth' // authorize all requests + ]); + + $res = $client->get('myproject/taskqueues/myqueue'); + + + + \Google\Auth\CredentialsLoader + \Google\Auth\GetQuotaProjectInterface + \Google\Auth\SignBlobInterface + \Google\Auth\ProjectIdProviderInterface + + + CRED_TYPE + \Google\Auth\Credentials\ServiceAccountCredentials::CRED_TYPE + 'sa' + + Used in observability metric headers + + + + + + + + IAM_SCOPE + \Google\Auth\Credentials\ServiceAccountCredentials::IAM_SCOPE + 'https://www.googleapis.com/auth/iam' + + + + + + + + + TOKEN_CREDENTIAL_URI + \Google\Auth\CredentialsLoader::TOKEN_CREDENTIAL_URI + 'https://oauth2.googleapis.com/token' + \Google\Auth\CredentialsLoader + + + + + + + + ENV_VAR + \Google\Auth\CredentialsLoader::ENV_VAR + 'GOOGLE_APPLICATION_CREDENTIALS' + \Google\Auth\CredentialsLoader + + + + + + + + QUOTA_PROJECT_ENV_VAR + \Google\Auth\CredentialsLoader::QUOTA_PROJECT_ENV_VAR + 'GOOGLE_CLOUD_QUOTA_PROJECT' + \Google\Auth\CredentialsLoader + + + + + + + + WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::WELL_KNOWN_PATH + 'gcloud/application_default_credentials.json' + \Google\Auth\CredentialsLoader + + + + + + + + NON_WINDOWS_WELL_KNOWN_PATH_BASE + \Google\Auth\CredentialsLoader::NON_WINDOWS_WELL_KNOWN_PATH_BASE + '.config' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::MTLS_WELL_KNOWN_PATH + '.secureConnect/context_aware_metadata.json' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_CERT_ENV_VAR + \Google\Auth\CredentialsLoader::MTLS_CERT_ENV_VAR + 'GOOGLE_API_USE_CLIENT_CERTIFICATE' + \Google\Auth\CredentialsLoader + + + + + + + + + auth + \Google\Auth\Credentials\ServiceAccountCredentials::$auth + + + The OAuth2 instance used to conduct authorization. + + + + + + + + quotaProject + \Google\Auth\Credentials\ServiceAccountCredentials::$quotaProject + + + The quota project associated with the JSON credentials + + + + + + + + projectId + \Google\Auth\Credentials\ServiceAccountCredentials::$projectId + + + + + + + + + + + lastReceivedJwtAccessToken + \Google\Auth\Credentials\ServiceAccountCredentials::$lastReceivedJwtAccessToken + + + + + + + + + + + useJwtAccessWithScope + \Google\Auth\Credentials\ServiceAccountCredentials::$useJwtAccessWithScope + false + + + + + + + + + + jwtAccessCredentials + \Google\Auth\Credentials\ServiceAccountCredentials::$jwtAccessCredentials + + + + + + + + + + + universeDomain + \Google\Auth\Credentials\ServiceAccountCredentials::$universeDomain + + + + + + + + + + + isIdTokenRequest + \Google\Auth\Credentials\ServiceAccountCredentials::$isIdTokenRequest + false + + Whether this is an ID token request or an access token request. Used when +building the metric header. + + + + + + + + __construct + \Google\Auth\Credentials\ServiceAccountCredentials::__construct() + + + scope + + string|string[]|null + + + + jsonKey + + string|array + + + + sub + null + string + + + + targetAudience + null + string + + + + Create a new ServiceAccountCredentials. + + + + + + + + + + + useJwtAccessWithScope + \Google\Auth\Credentials\ServiceAccountCredentials::useJwtAccessWithScope() + + + When called, the ServiceAccountCredentials will use an instance of +ServiceAccountJwtAccessCredentials to fetch (self-sign) an access token +even when only scopes are supplied. Otherwise, +ServiceAccountJwtAccessCredentials is only called when no scopes and an +authUrl (audience) is suppled. + + + + + + + + fetchAuthToken + \Google\Auth\Credentials\ServiceAccountCredentials::fetchAuthToken() + + + httpHandler + null + callable|null + + + + headers + [] + array + + + + Fetches the auth tokens based on the current state. + + + + + + + + + + getCacheKey + \Google\Auth\Credentials\ServiceAccountCredentials::getCacheKey() + + + Return the Cache Key for the credentials. + For the cache key format is one of the following: +ClientEmail.Scope[.Sub] +ClientEmail.Audience[.Sub] + + + + + + + getLastReceivedToken + \Google\Auth\Credentials\ServiceAccountCredentials::getLastReceivedToken() + + + Returns an associative array with the token and +expiration time. + + + + + + + + getProjectId + \Google\Auth\Credentials\ServiceAccountCredentials::getProjectId() + + + httpHandler + null + callable|null + + + + Get the project ID from the service account keyfile. + Returns null if the project ID does not exist in the keyfile. + + + + + + + + updateMetadata + \Google\Auth\Credentials\ServiceAccountCredentials::updateMetadata() + + + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + createJwtAccessCredentials + \Google\Auth\Credentials\ServiceAccountCredentials::createJwtAccessCredentials() + + + + + + + + + + + setSub + \Google\Auth\Credentials\ServiceAccountCredentials::setSub() + + + sub + + string + + + + + + + + + + + + + getClientName + \Google\Auth\Credentials\ServiceAccountCredentials::getClientName() + + + httpHandler + null + callable|null + + + + Get the client name from the keyfile. + In this case, it returns the keyfile's client_email key. + + + + + + + + getPrivateKey + \Google\Auth\Credentials\ServiceAccountCredentials::getPrivateKey() + + + Get the private key from the keyfile. + In this case, it returns the keyfile's private_key key, needed for JWT signing. + + + + + + + getQuotaProject + \Google\Auth\Credentials\ServiceAccountCredentials::getQuotaProject() + + + Get the quota project used for this API request + + + + + + + + getUniverseDomain + \Google\Auth\Credentials\ServiceAccountCredentials::getUniverseDomain() + + + Get the universe domain configured in the JSON credential. + + + + + + + + getCredType + \Google\Auth\Credentials\ServiceAccountCredentials::getCredType() + + + + + + + + + + useSelfSignedJwt + \Google\Auth\Credentials\ServiceAccountCredentials::useSelfSignedJwt() + + + + + + + + + + + getUpdateMetadataFunc + \Google\Auth\UpdateMetadataTrait::getUpdateMetadataFunc() + + \Google\Auth\UpdateMetadataTrait + export a callback function which updates runtime metadata. + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataTrait::updateMetadata() + + \Google\Auth\UpdateMetadataTrait + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + fromEnv + \Google\Auth\CredentialsLoader::fromEnv() + + \Google\Auth\CredentialsLoader + Load a JSON key from the path specified in the environment. + Load a JSON key from the path specified in the environment +variable GOOGLE_APPLICATION_CREDENTIALS. Return null if +GOOGLE_APPLICATION_CREDENTIALS is not specified. + + + + + + + fromWellKnownFile + \Google\Auth\CredentialsLoader::fromWellKnownFile() + + \Google\Auth\CredentialsLoader + Load a JSON key from a well known path. + The well known path is OS dependent: + +* windows: %APPDATA%/gcloud/application_default_credentials.json +* others: $HOME/.config/gcloud/application_default_credentials.json + +If the file does not exist, this returns null. + + + + + + + makeCredentials + \Google\Auth\CredentialsLoader::makeCredentials() + + \Google\Auth\CredentialsLoader + scope + + string|string[] + + + + jsonKey + + array + + + + defaultScope + null + string|string[] + + + + Create a new Credentials instance. + + + + + + + + + + + + + makeHttpClient + \Google\Auth\CredentialsLoader::makeHttpClient() + + \Google\Auth\CredentialsLoader + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + httpClientOptions + [] + array + + + + httpHandler + null + callable|null + + + + tokenCallback + null + callable|null + + + + Create an authorized HTTP Client from an instance of FetchAuthTokenInterface. + + + + + + + + + + + + makeInsecureCredentials + \Google\Auth\CredentialsLoader::makeInsecureCredentials() + + \Google\Auth\CredentialsLoader + Create a new instance of InsecureCredentials. + + + + + + + + quotaProjectFromEnv + \Google\Auth\CredentialsLoader::quotaProjectFromEnv() + + \Google\Auth\CredentialsLoader + Fetch a quota project from the environment variable +GOOGLE_CLOUD_QUOTA_PROJECT. Return null if +GOOGLE_CLOUD_QUOTA_PROJECT is not specified. + + + + + + + + getDefaultClientCertSource + \Google\Auth\CredentialsLoader::getDefaultClientCertSource() + + \Google\Auth\CredentialsLoader + Gets a callable which returns the default device certification. + + + + + + + + + shouldLoadClientCertSource + \Google\Auth\CredentialsLoader::shouldLoadClientCertSource() + + \Google\Auth\CredentialsLoader + Determines whether or not the default device certificate should be loaded. + + + + + + + + getUniverseDomain + \Google\Auth\CredentialsLoader::getUniverseDomain() + + \Google\Auth\CredentialsLoader + Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain. + + + + + + + + signBlob + \Google\Auth\ServiceAccountSignerTrait::signBlob() + + \Google\Auth\ServiceAccountSignerTrait + stringToSign + + string + + + + forceOpenssl + false + bool + + + + Sign a string using the service account private key. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ServiceAccountJwtAccessCredentials + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials + + Authenticates requests using Google's Service Account credentials via +JWT Access. + This class allows authorizing requests for service accounts directly +from credentials from a json key file downloaded from the developer +console (via 'Generate new Json Key'). It is not part of any OAuth2 +flow, rather it creates a JWT and sends that as a credential. + + + + \Google\Auth\CredentialsLoader + \Google\Auth\GetQuotaProjectInterface + \Google\Auth\SignBlobInterface + \Google\Auth\ProjectIdProviderInterface + + + CRED_TYPE + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::CRED_TYPE + 'jwt' + + Used in observability metric headers + + + + + + + + TOKEN_CREDENTIAL_URI + \Google\Auth\CredentialsLoader::TOKEN_CREDENTIAL_URI + 'https://oauth2.googleapis.com/token' + \Google\Auth\CredentialsLoader + + + + + + + + ENV_VAR + \Google\Auth\CredentialsLoader::ENV_VAR + 'GOOGLE_APPLICATION_CREDENTIALS' + \Google\Auth\CredentialsLoader + + + + + + + + QUOTA_PROJECT_ENV_VAR + \Google\Auth\CredentialsLoader::QUOTA_PROJECT_ENV_VAR + 'GOOGLE_CLOUD_QUOTA_PROJECT' + \Google\Auth\CredentialsLoader + + + + + + + + WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::WELL_KNOWN_PATH + 'gcloud/application_default_credentials.json' + \Google\Auth\CredentialsLoader + + + + + + + + NON_WINDOWS_WELL_KNOWN_PATH_BASE + \Google\Auth\CredentialsLoader::NON_WINDOWS_WELL_KNOWN_PATH_BASE + '.config' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::MTLS_WELL_KNOWN_PATH + '.secureConnect/context_aware_metadata.json' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_CERT_ENV_VAR + \Google\Auth\CredentialsLoader::MTLS_CERT_ENV_VAR + 'GOOGLE_API_USE_CLIENT_CERTIFICATE' + \Google\Auth\CredentialsLoader + + + + + + + + + auth + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::$auth + + + The OAuth2 instance used to conduct authorization. + + + + + + + + quotaProject + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::$quotaProject + + + The quota project associated with the JSON credentials + + + + + + + + projectId + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::$projectId + + + + + + + + + + + + __construct + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::__construct() + + + jsonKey + + string|array + + + + scope + null + string|string[] + + + + Create a new ServiceAccountJwtAccessCredentials. + + + + + + + + + updateMetadata + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::updateMetadata() + + + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + fetchAuthToken + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::fetchAuthToken() + + + httpHandler + null + callable|null + + + + Implements FetchAuthTokenInterface#fetchAuthToken. + + + + + + + + + getCacheKey + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::getCacheKey() + + + Return the cache key for the credentials. + The format for the Cache Key one of the following: +ClientEmail.Scope +ClientEmail.Audience + + + + + + + getLastReceivedToken + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::getLastReceivedToken() + + + Returns an associative array with the token and +expiration time. + + + + + + + + getProjectId + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::getProjectId() + + + httpHandler + null + callable|null + + + + Get the project ID from the service account keyfile. + Returns null if the project ID does not exist in the keyfile. + + + + + + + + getClientName + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::getClientName() + + + httpHandler + null + callable|null + + + + Get the client name from the keyfile. + In this case, it returns the keyfile's client_email key. + + + + + + + + getPrivateKey + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::getPrivateKey() + + + Get the private key from the keyfile. + In this case, it returns the keyfile's private_key key, needed for JWT signing. + + + + + + + getQuotaProject + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::getQuotaProject() + + + Get the quota project used for this API request + + + + + + + + getCredType + \Google\Auth\Credentials\ServiceAccountJwtAccessCredentials::getCredType() + + + + + + + + + + getUpdateMetadataFunc + \Google\Auth\UpdateMetadataTrait::getUpdateMetadataFunc() + + \Google\Auth\UpdateMetadataTrait + export a callback function which updates runtime metadata. + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataTrait::updateMetadata() + + \Google\Auth\UpdateMetadataTrait + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + fromEnv + \Google\Auth\CredentialsLoader::fromEnv() + + \Google\Auth\CredentialsLoader + Load a JSON key from the path specified in the environment. + Load a JSON key from the path specified in the environment +variable GOOGLE_APPLICATION_CREDENTIALS. Return null if +GOOGLE_APPLICATION_CREDENTIALS is not specified. + + + + + + + fromWellKnownFile + \Google\Auth\CredentialsLoader::fromWellKnownFile() + + \Google\Auth\CredentialsLoader + Load a JSON key from a well known path. + The well known path is OS dependent: + +* windows: %APPDATA%/gcloud/application_default_credentials.json +* others: $HOME/.config/gcloud/application_default_credentials.json + +If the file does not exist, this returns null. + + + + + + + makeCredentials + \Google\Auth\CredentialsLoader::makeCredentials() + + \Google\Auth\CredentialsLoader + scope + + string|string[] + + + + jsonKey + + array + + + + defaultScope + null + string|string[] + + + + Create a new Credentials instance. + + + + + + + + + + + + + makeHttpClient + \Google\Auth\CredentialsLoader::makeHttpClient() + + \Google\Auth\CredentialsLoader + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + httpClientOptions + [] + array + + + + httpHandler + null + callable|null + + + + tokenCallback + null + callable|null + + + + Create an authorized HTTP Client from an instance of FetchAuthTokenInterface. + + + + + + + + + + + + makeInsecureCredentials + \Google\Auth\CredentialsLoader::makeInsecureCredentials() + + \Google\Auth\CredentialsLoader + Create a new instance of InsecureCredentials. + + + + + + + + quotaProjectFromEnv + \Google\Auth\CredentialsLoader::quotaProjectFromEnv() + + \Google\Auth\CredentialsLoader + Fetch a quota project from the environment variable +GOOGLE_CLOUD_QUOTA_PROJECT. Return null if +GOOGLE_CLOUD_QUOTA_PROJECT is not specified. + + + + + + + + getDefaultClientCertSource + \Google\Auth\CredentialsLoader::getDefaultClientCertSource() + + \Google\Auth\CredentialsLoader + Gets a callable which returns the default device certification. + + + + + + + + + shouldLoadClientCertSource + \Google\Auth\CredentialsLoader::shouldLoadClientCertSource() + + \Google\Auth\CredentialsLoader + Determines whether or not the default device certificate should be loaded. + + + + + + + + getUniverseDomain + \Google\Auth\CredentialsLoader::getUniverseDomain() + + \Google\Auth\CredentialsLoader + Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain. + + + + + + + + signBlob + \Google\Auth\ServiceAccountSignerTrait::signBlob() + + \Google\Auth\ServiceAccountSignerTrait + stringToSign + + string + + + + forceOpenssl + false + bool + + + + Sign a string using the service account private key. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + UserRefreshCredentials + \Google\Auth\Credentials\UserRefreshCredentials + + Authenticates requests using User Refresh credentials. + This class allows authorizing requests from user refresh tokens. + +This the end of the result of a 3LO flow. E.g, the end result of +'gcloud auth login' saves a file with these contents in well known +location + + + + + \Google\Auth\CredentialsLoader + \Google\Auth\GetQuotaProjectInterface + + + CRED_TYPE + \Google\Auth\Credentials\UserRefreshCredentials::CRED_TYPE + 'u' + + Used in observability metric headers + + + + + + + + TOKEN_CREDENTIAL_URI + \Google\Auth\CredentialsLoader::TOKEN_CREDENTIAL_URI + 'https://oauth2.googleapis.com/token' + \Google\Auth\CredentialsLoader + + + + + + + + ENV_VAR + \Google\Auth\CredentialsLoader::ENV_VAR + 'GOOGLE_APPLICATION_CREDENTIALS' + \Google\Auth\CredentialsLoader + + + + + + + + QUOTA_PROJECT_ENV_VAR + \Google\Auth\CredentialsLoader::QUOTA_PROJECT_ENV_VAR + 'GOOGLE_CLOUD_QUOTA_PROJECT' + \Google\Auth\CredentialsLoader + + + + + + + + WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::WELL_KNOWN_PATH + 'gcloud/application_default_credentials.json' + \Google\Auth\CredentialsLoader + + + + + + + + NON_WINDOWS_WELL_KNOWN_PATH_BASE + \Google\Auth\CredentialsLoader::NON_WINDOWS_WELL_KNOWN_PATH_BASE + '.config' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::MTLS_WELL_KNOWN_PATH + '.secureConnect/context_aware_metadata.json' + \Google\Auth\CredentialsLoader + + + + + + + + MTLS_CERT_ENV_VAR + \Google\Auth\CredentialsLoader::MTLS_CERT_ENV_VAR + 'GOOGLE_API_USE_CLIENT_CERTIFICATE' + \Google\Auth\CredentialsLoader + + + + + + + + + auth + \Google\Auth\Credentials\UserRefreshCredentials::$auth + + + The OAuth2 instance used to conduct authorization. + + + + + + + + quotaProject + \Google\Auth\Credentials\UserRefreshCredentials::$quotaProject + + + The quota project associated with the JSON credentials + + + + + + + + isIdTokenRequest + \Google\Auth\Credentials\UserRefreshCredentials::$isIdTokenRequest + false + + Whether this is an ID token request or an access token request. Used when +building the metric header. + + + + + + + + __construct + \Google\Auth\Credentials\UserRefreshCredentials::__construct() + + + scope + + string|string[]|null + + + + jsonKey + + string|array + + + + targetAudience + null + string|null + + + + Create a new UserRefreshCredentials. + + + + + + + + + + fetchAuthToken + \Google\Auth\Credentials\UserRefreshCredentials::fetchAuthToken() + + + httpHandler + null + callable|null + + + + headers + [] + array + + + + Fetches the auth tokens based on the current state. + + + + + + + + + + getCacheKey + \Google\Auth\Credentials\UserRefreshCredentials::getCacheKey() + + + Return the Cache Key for the credentials. + The format for the Cache key is one of the following: +ClientId.Scope +ClientId.Audience + + + + + + + getLastReceivedToken + \Google\Auth\Credentials\UserRefreshCredentials::getLastReceivedToken() + + + Returns an associative array with the token and +expiration time. + + + + + + + + getQuotaProject + \Google\Auth\Credentials\UserRefreshCredentials::getQuotaProject() + + + Get the quota project used for this API request + + + + + + + + getGrantedScope + \Google\Auth\Credentials\UserRefreshCredentials::getGrantedScope() + + + Get the granted scopes (if they exist) for the last fetched token. + + + + + + + + getCredType + \Google\Auth\Credentials\UserRefreshCredentials::getCredType() + + + + + + + + + + getUpdateMetadataFunc + \Google\Auth\UpdateMetadataTrait::getUpdateMetadataFunc() + + \Google\Auth\UpdateMetadataTrait + export a callback function which updates runtime metadata. + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataTrait::updateMetadata() + + \Google\Auth\UpdateMetadataTrait + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + fromEnv + \Google\Auth\CredentialsLoader::fromEnv() + + \Google\Auth\CredentialsLoader + Load a JSON key from the path specified in the environment. + Load a JSON key from the path specified in the environment +variable GOOGLE_APPLICATION_CREDENTIALS. Return null if +GOOGLE_APPLICATION_CREDENTIALS is not specified. + + + + + + + fromWellKnownFile + \Google\Auth\CredentialsLoader::fromWellKnownFile() + + \Google\Auth\CredentialsLoader + Load a JSON key from a well known path. + The well known path is OS dependent: + +* windows: %APPDATA%/gcloud/application_default_credentials.json +* others: $HOME/.config/gcloud/application_default_credentials.json + +If the file does not exist, this returns null. + + + + + + + makeCredentials + \Google\Auth\CredentialsLoader::makeCredentials() + + \Google\Auth\CredentialsLoader + scope + + string|string[] + + + + jsonKey + + array + + + + defaultScope + null + string|string[] + + + + Create a new Credentials instance. + + + + + + + + + + + + + makeHttpClient + \Google\Auth\CredentialsLoader::makeHttpClient() + + \Google\Auth\CredentialsLoader + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + httpClientOptions + [] + array + + + + httpHandler + null + callable|null + + + + tokenCallback + null + callable|null + + + + Create an authorized HTTP Client from an instance of FetchAuthTokenInterface. + + + + + + + + + + + + makeInsecureCredentials + \Google\Auth\CredentialsLoader::makeInsecureCredentials() + + \Google\Auth\CredentialsLoader + Create a new instance of InsecureCredentials. + + + + + + + + quotaProjectFromEnv + \Google\Auth\CredentialsLoader::quotaProjectFromEnv() + + \Google\Auth\CredentialsLoader + Fetch a quota project from the environment variable +GOOGLE_CLOUD_QUOTA_PROJECT. Return null if +GOOGLE_CLOUD_QUOTA_PROJECT is not specified. + + + + + + + + getDefaultClientCertSource + \Google\Auth\CredentialsLoader::getDefaultClientCertSource() + + \Google\Auth\CredentialsLoader + Gets a callable which returns the default device certification. + + + + + + + + + shouldLoadClientCertSource + \Google\Auth\CredentialsLoader::shouldLoadClientCertSource() + + \Google\Auth\CredentialsLoader + Determines whether or not the default device certificate should be loaded. + + + + + + + + getUniverseDomain + \Google\Auth\CredentialsLoader::getUniverseDomain() + + \Google\Auth\CredentialsLoader + Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain. + + + + + + + + + + + Tag "see" with body "@see [Application Default Credentials](http://goo.gl/mkAHpZ)" has error "\Google\Auth\Credentials\[Application" is not a valid Fqsen. + + + + + + + + + + + + + + + + + + + + CredentialsLoader + \Google\Auth\CredentialsLoader + + CredentialsLoader contains the behaviour used to locate and find default +credentials files on the file system. + + + + + + \Google\Auth\GetUniverseDomainInterface + \Google\Auth\FetchAuthTokenInterface + \Google\Auth\UpdateMetadataInterface + + + TOKEN_CREDENTIAL_URI + \Google\Auth\CredentialsLoader::TOKEN_CREDENTIAL_URI + 'https://oauth2.googleapis.com/token' + + + + + + + + + ENV_VAR + \Google\Auth\CredentialsLoader::ENV_VAR + 'GOOGLE_APPLICATION_CREDENTIALS' + + + + + + + + + QUOTA_PROJECT_ENV_VAR + \Google\Auth\CredentialsLoader::QUOTA_PROJECT_ENV_VAR + 'GOOGLE_CLOUD_QUOTA_PROJECT' + + + + + + + + + WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::WELL_KNOWN_PATH + 'gcloud/application_default_credentials.json' + + + + + + + + + NON_WINDOWS_WELL_KNOWN_PATH_BASE + \Google\Auth\CredentialsLoader::NON_WINDOWS_WELL_KNOWN_PATH_BASE + '.config' + + + + + + + + + MTLS_WELL_KNOWN_PATH + \Google\Auth\CredentialsLoader::MTLS_WELL_KNOWN_PATH + '.secureConnect/context_aware_metadata.json' + + + + + + + + + MTLS_CERT_ENV_VAR + \Google\Auth\CredentialsLoader::MTLS_CERT_ENV_VAR + 'GOOGLE_API_USE_CLIENT_CERTIFICATE' + + + + + + + + + + + unableToReadEnv + \Google\Auth\CredentialsLoader::unableToReadEnv() + + + cause + + string + + + + + + + + + + + + + isOnWindows + \Google\Auth\CredentialsLoader::isOnWindows() + + + + + + + + + + + fromEnv + \Google\Auth\CredentialsLoader::fromEnv() + + + Load a JSON key from the path specified in the environment. + Load a JSON key from the path specified in the environment +variable GOOGLE_APPLICATION_CREDENTIALS. Return null if +GOOGLE_APPLICATION_CREDENTIALS is not specified. + + + + + + + fromWellKnownFile + \Google\Auth\CredentialsLoader::fromWellKnownFile() + + + Load a JSON key from a well known path. + The well known path is OS dependent: + +* windows: %APPDATA%/gcloud/application_default_credentials.json +* others: $HOME/.config/gcloud/application_default_credentials.json + +If the file does not exist, this returns null. + + + + + + + makeCredentials + \Google\Auth\CredentialsLoader::makeCredentials() + + + scope + + string|string[] + + + + jsonKey + + array + + + + defaultScope + null + string|string[] + + + + Create a new Credentials instance. + + + + + + + + + + + + + makeHttpClient + \Google\Auth\CredentialsLoader::makeHttpClient() + + + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + httpClientOptions + [] + array + + + + httpHandler + null + callable|null + + + + tokenCallback + null + callable|null + + + + Create an authorized HTTP Client from an instance of FetchAuthTokenInterface. + + + + + + + + + + + + makeInsecureCredentials + \Google\Auth\CredentialsLoader::makeInsecureCredentials() + + + Create a new instance of InsecureCredentials. + + + + + + + + quotaProjectFromEnv + \Google\Auth\CredentialsLoader::quotaProjectFromEnv() + + + Fetch a quota project from the environment variable +GOOGLE_CLOUD_QUOTA_PROJECT. Return null if +GOOGLE_CLOUD_QUOTA_PROJECT is not specified. + + + + + + + + getDefaultClientCertSource + \Google\Auth\CredentialsLoader::getDefaultClientCertSource() + + + Gets a callable which returns the default device certification. + + + + + + + + + shouldLoadClientCertSource + \Google\Auth\CredentialsLoader::shouldLoadClientCertSource() + + + Determines whether or not the default device certificate should be loaded. + + + + + + + + loadDefaultClientCertSourceFile + \Google\Auth\CredentialsLoader::loadDefaultClientCertSourceFile() + + + + + + + + + + + getUniverseDomain + \Google\Auth\CredentialsLoader::getUniverseDomain() + + + Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain. + + + + + + + + getEnv + \Google\Auth\CredentialsLoader::getEnv() + + + env + + string + + + + + + + + + + + getUpdateMetadataFunc + \Google\Auth\UpdateMetadataTrait::getUpdateMetadataFunc() + + \Google\Auth\UpdateMetadataTrait + export a callback function which updates runtime metadata. + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataTrait::updateMetadata() + + \Google\Auth\UpdateMetadataTrait + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AwsNativeSource + \Google\Auth\CredentialSource\AwsNativeSource + + Authenticates requests using AWS credentials. + + + + + + \Google\Auth\ExternalAccountCredentialSourceInterface + + + CRED_VERIFICATION_QUERY + \Google\Auth\CredentialSource\AwsNativeSource::CRED_VERIFICATION_QUERY + 'Action=GetCallerIdentity&Version=2011-06-15' + + + + + + + + + + audience + \Google\Auth\CredentialSource\AwsNativeSource::$audience + + + + + + + + + + regionalCredVerificationUrl + \Google\Auth\CredentialSource\AwsNativeSource::$regionalCredVerificationUrl + + + + + + + + + + regionUrl + \Google\Auth\CredentialSource\AwsNativeSource::$regionUrl + + + + + + + + + + securityCredentialsUrl + \Google\Auth\CredentialSource\AwsNativeSource::$securityCredentialsUrl + + + + + + + + + + imdsv2SessionTokenUrl + \Google\Auth\CredentialSource\AwsNativeSource::$imdsv2SessionTokenUrl + + + + + + + + + + + __construct + \Google\Auth\CredentialSource\AwsNativeSource::__construct() + + + audience + + string + + + + regionalCredVerificationUrl + + string + + + + regionUrl + null + string|null + + + + securityCredentialsUrl + null + string|null + + + + imdsv2SessionTokenUrl + null + string|null + + + + + + + + + + + + + + + + fetchSubjectToken + \Google\Auth\CredentialSource\AwsNativeSource::fetchSubjectToken() + + + httpHandler + null + ?callable + + + + + + + + + + + getImdsV2SessionToken + \Google\Auth\CredentialSource\AwsNativeSource::getImdsV2SessionToken() + + + imdsV2Url + + string + + + + httpHandler + + callable + + + + + + + + + + + + getSignedRequestHeaders + \Google\Auth\CredentialSource\AwsNativeSource::getSignedRequestHeaders() + + + region + + string + + + + host + + string + + + + accessKeyId + + string + + + + secretAccessKey + + string + + + + securityToken + + ?string + + + + + + + + + + + + + + getRegionFromEnv + \Google\Auth\CredentialSource\AwsNativeSource::getRegionFromEnv() + + + + + + + + + + + getRegionFromUrl + \Google\Auth\CredentialSource\AwsNativeSource::getRegionFromUrl() + + + httpHandler + + callable + + + + regionUrl + + string + + + + headers + + array<string,string|string[]> + + + + + + + + + + + + + + + getRoleName + \Google\Auth\CredentialSource\AwsNativeSource::getRoleName() + + + httpHandler + + callable + + + + securityCredentialsUrl + + string + + + + headers + + array<string,string|string[]> + + + + + + + + + + + + + + + getSigningVarsFromUrl + \Google\Auth\CredentialSource\AwsNativeSource::getSigningVarsFromUrl() + + + httpHandler + + callable + + + + securityCredentialsUrl + + string + + + + roleName + + string + + + + headers + + array<string,string|string[]> + + + + + + + + + + + + + + + + getSigningVarsFromEnv + \Google\Auth\CredentialSource\AwsNativeSource::getSigningVarsFromEnv() + + + + + + + + + + + + getCacheKey + \Google\Auth\CredentialSource\AwsNativeSource::getCacheKey() + + + Gets the unique key for caching +For AwsNativeSource the values are: +Imdsv2SessionTokenUrl.SecurityCredentialsUrl.RegionUrl.RegionalCredVerificationUrl + + + + + + + + hmacSign + \Google\Auth\CredentialSource\AwsNativeSource::hmacSign() + + + key + + string + + + + msg + + string + + + + Return HMAC hash in binary string + + + + + + + utf8Encode + \Google\Auth\CredentialSource\AwsNativeSource::utf8Encode() + + + string + + string + + + + + + + + + + + + getSignatureKey + \Google\Auth\CredentialSource\AwsNativeSource::getSignatureKey() + + + key + + string + + + + dateStamp + + string + + + + regionName + + string + + + + serviceName + + string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ExecutableSource + \Google\Auth\CredentialSource\ExecutableSource + + ExecutableSource enables the exchange of workload identity pool external credentials for +Google access tokens by retrieving 3rd party tokens through a user supplied executable. These +scripts/executables are completely independent of the Google Cloud Auth libraries. These +credentials plug into ADC and will call the specified executable to retrieve the 3rd party token +to be exchanged for a Google access token. + To use these credentials, the GOOGLE_EXTERNAL_ACCOUNT_ALLOW_EXECUTABLES environment variable +must be set to '1'. This is for security reasons. + +Both OIDC and SAML are supported. The executable must adhere to a specific response format +defined below. + +The executable must print out the 3rd party token to STDOUT in JSON format. When an +output_file is specified in the credential configuration, the executable must also handle writing the +JSON response to this file. + +<pre> +OIDC response sample: +{ + "version": 1, + "success": true, + "token_type": "urn:ietf:params:oauth:token-type:id_token", + "id_token": "HEADER.PAYLOAD.SIGNATURE", + "expiration_time": 1620433341 +} + +SAML2 response sample: +{ + "version": 1, + "success": true, + "token_type": "urn:ietf:params:oauth:token-type:saml2", + "saml_response": "...", + "expiration_time": 1620433341 +} + +Error response sample: +{ + "version": 1, + "success": false, + "code": "401", + "message": "Error message." +} +</pre> + +The "expiration_time" field in the JSON response is only required for successful +responses when an output file was specified in the credential configuration + +The auth libraries will populate certain environment variables that will be accessible by the +executable, such as: GOOGLE_EXTERNAL_ACCOUNT_AUDIENCE, GOOGLE_EXTERNAL_ACCOUNT_TOKEN_TYPE, +GOOGLE_EXTERNAL_ACCOUNT_INTERACTIVE, GOOGLE_EXTERNAL_ACCOUNT_IMPERSONATED_EMAIL, and +GOOGLE_EXTERNAL_ACCOUNT_OUTPUT_FILE. + + + + + \Google\Auth\ExternalAccountCredentialSourceInterface + + + GOOGLE_EXTERNAL_ACCOUNT_ALLOW_EXECUTABLES + \Google\Auth\CredentialSource\ExecutableSource::GOOGLE_EXTERNAL_ACCOUNT_ALLOW_EXECUTABLES + 'GOOGLE_EXTERNAL_ACCOUNT_ALLOW_EXECUTABLES' + + + + + + + + + SAML_SUBJECT_TOKEN_TYPE + \Google\Auth\CredentialSource\ExecutableSource::SAML_SUBJECT_TOKEN_TYPE + 'urn:ietf:params:oauth:token-type:saml2' + + + + + + + + + OIDC_SUBJECT_TOKEN_TYPE1 + \Google\Auth\CredentialSource\ExecutableSource::OIDC_SUBJECT_TOKEN_TYPE1 + 'urn:ietf:params:oauth:token-type:id_token' + + + + + + + + + OIDC_SUBJECT_TOKEN_TYPE2 + \Google\Auth\CredentialSource\ExecutableSource::OIDC_SUBJECT_TOKEN_TYPE2 + 'urn:ietf:params:oauth:token-type:jwt' + + + + + + + + + + command + \Google\Auth\CredentialSource\ExecutableSource::$command + + + + + + + + + + executableHandler + \Google\Auth\CredentialSource\ExecutableSource::$executableHandler + + + + + + + + + + outputFile + \Google\Auth\CredentialSource\ExecutableSource::$outputFile + + + + + + + + + + + __construct + \Google\Auth\CredentialSource\ExecutableSource::__construct() + + + command + + string + + + + outputFile + + string|null + + + + executableHandler + null + ?\Google\Auth\ExecutableHandler\ExecutableHandler + + + + + + + + + + + + + getCacheKey + \Google\Auth\CredentialSource\ExecutableSource::getCacheKey() + + + Gets the unique key for caching +The format for the cache key is: +Command.OutputFile + + + + + + + + fetchSubjectToken + \Google\Auth\CredentialSource\ExecutableSource::fetchSubjectToken() + + + httpHandler + null + callable|null + + + + + + + + + + + + + + + getCachedExecutableResponse + \Google\Auth\CredentialSource\ExecutableSource::getCachedExecutableResponse() + + + + + + + + + + + parseExecutableResponse + \Google\Auth\CredentialSource\ExecutableSource::parseExecutableResponse() + + + response + + string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + FileSource + \Google\Auth\CredentialSource\FileSource + + Retrieve a token from a file. + + + + + + \Google\Auth\ExternalAccountCredentialSourceInterface + + + + file + \Google\Auth\CredentialSource\FileSource::$file + + + + + + + + + + format + \Google\Auth\CredentialSource\FileSource::$format + + + + + + + + + + subjectTokenFieldName + \Google\Auth\CredentialSource\FileSource::$subjectTokenFieldName + + + + + + + + + + + __construct + \Google\Auth\CredentialSource\FileSource::__construct() + + + file + + string + + + + format + null + string|null + + + + subjectTokenFieldName + null + string|null + + + + + + + + + + + + + + fetchSubjectToken + \Google\Auth\CredentialSource\FileSource::fetchSubjectToken() + + + httpHandler + null + ?callable + + + + + + + + + + + getCacheKey + \Google\Auth\CredentialSource\FileSource::getCacheKey() + + + Gets the unique key for caching. + The format for the cache key one of the following: +Filename + + + + + + + + + + + + + + + + + + + + + + + + + + + + + UrlSource + \Google\Auth\CredentialSource\UrlSource + + Retrieve a token from a URL. + + + + + + \Google\Auth\ExternalAccountCredentialSourceInterface + + + + url + \Google\Auth\CredentialSource\UrlSource::$url + + + + + + + + + + format + \Google\Auth\CredentialSource\UrlSource::$format + + + + + + + + + + subjectTokenFieldName + \Google\Auth\CredentialSource\UrlSource::$subjectTokenFieldName + + + + + + + + + + headers + \Google\Auth\CredentialSource\UrlSource::$headers + + + + + + + + + + + + __construct + \Google\Auth\CredentialSource\UrlSource::__construct() + + + url + + string + + + + format + null + string|null + + + + subjectTokenFieldName + null + string|null + + + + headers + null + array<string,string|string[]>|null + + + + + + + + + + + + + + + fetchSubjectToken + \Google\Auth\CredentialSource\UrlSource::fetchSubjectToken() + + + httpHandler + null + ?callable + + + + + + + + + + + getCacheKey + \Google\Auth\CredentialSource\UrlSource::getCacheKey() + + + Get the cache key for the credentials. + The format for the cache key is: +URL + + + + + + + + + + + + + + Copyright 2024 Google Inc. All Rights Reserved. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + ExecutableHandler + \Google\Auth\ExecutableHandler\ExecutableHandler + + + + + + + + + + DEFAULT_EXECUTABLE_TIMEOUT_MILLIS + \Google\Auth\ExecutableHandler\ExecutableHandler::DEFAULT_EXECUTABLE_TIMEOUT_MILLIS + 30 * 1000 + + + + + + + + + + timeoutMs + \Google\Auth\ExecutableHandler\ExecutableHandler::$timeoutMs + + + + + + + + + + env + \Google\Auth\ExecutableHandler\ExecutableHandler::$env + [] + + + + + + + + + + output + \Google\Auth\ExecutableHandler\ExecutableHandler::$output + null + + + + + + + + + + __construct + \Google\Auth\ExecutableHandler\ExecutableHandler::__construct() + + + env + [] + (string|\Stringable)[] + + + + timeoutMs + \self::DEFAULT_EXECUTABLE_TIMEOUT_MILLIS + int + + + + + + + + + + + + __invoke + \Google\Auth\ExecutableHandler\ExecutableHandler::__invoke() + + + command + + string + + + + + + + + + + + + + getOutput + \Google\Auth\ExecutableHandler\ExecutableHandler::getOutput() + + + + + + + + + + + + + + + + + Copyright 2024 Google Inc. All Rights Reserved. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + ExecutableResponseError + \Google\Auth\ExecutableHandler\ExecutableResponseError + + + + + + + \Error + + + + + __construct + \Google\Auth\ExecutableHandler\ExecutableResponseError::__construct() + + + message + + string + + + + executableErrorCode + 'INVALID_EXECUTABLE_RESPONSE' + string + + + + + + + + + + + + + + + + + + Copyright 2023 Google Inc. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + ExternalAccountCredentialSourceInterface + \Google\Auth\ExternalAccountCredentialSourceInterface + + + + + + + + fetchSubjectToken + \Google\Auth\ExternalAccountCredentialSourceInterface::fetchSubjectToken() + + + httpHandler + null + ?callable + + + + + + + + + + + getCacheKey + \Google\Auth\ExternalAccountCredentialSourceInterface::getCacheKey() + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + FetchAuthTokenCache + \Google\Auth\FetchAuthTokenCache + + A class to implement caching for any object implementing +FetchAuthTokenInterface + + + + + + \Google\Auth\FetchAuthTokenInterface + \Google\Auth\GetQuotaProjectInterface + \Google\Auth\GetUniverseDomainInterface + \Google\Auth\SignBlobInterface + \Google\Auth\ProjectIdProviderInterface + \Google\Auth\UpdateMetadataInterface + + + + fetcher + \Google\Auth\FetchAuthTokenCache::$fetcher + + + + + + + + + + + eagerRefreshThresholdSeconds + \Google\Auth\FetchAuthTokenCache::$eagerRefreshThresholdSeconds + 10 + + + + + + + + + + maxKeyLength + \Google\Auth\CacheTrait::$maxKeyLength + 64 + \Google\Auth\CacheTrait + + + + + + + + + cacheConfig + \Google\Auth\CacheTrait::$cacheConfig + + \Google\Auth\CacheTrait + + + + + + + + + cache + \Google\Auth\CacheTrait::$cache + + \Google\Auth\CacheTrait + + + + + + + + + + __construct + \Google\Auth\FetchAuthTokenCache::__construct() + + + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + cacheConfig + null + array|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface + + + + + + + + + + + + + + getFetcher + \Google\Auth\FetchAuthTokenCache::getFetcher() + + + + + + + + + + + fetchAuthToken + \Google\Auth\FetchAuthTokenCache::fetchAuthToken() + + + httpHandler + null + callable|null + + + + Implements FetchAuthTokenInterface#fetchAuthToken. + Checks the cache for a valid auth token and fetches the auth tokens +from the supplied fetcher. + + + + + + + + + getCacheKey + \Google\Auth\FetchAuthTokenCache::getCacheKey() + + + Obtains a key that can used to cache the results of #fetchAuthToken. + + + + + + + + getLastReceivedToken + \Google\Auth\FetchAuthTokenCache::getLastReceivedToken() + + + Returns an associative array with the token and +expiration time. + + + + + + + + getClientName + \Google\Auth\FetchAuthTokenCache::getClientName() + + + httpHandler + null + callable|null + + + + Get the client name from the fetcher. + + + + + + + + + signBlob + \Google\Auth\FetchAuthTokenCache::signBlob() + + + stringToSign + + string + + + + forceOpenSsl + false + bool + + + + Sign a blob using the fetcher. + + + + + + + + + + + getQuotaProject + \Google\Auth\FetchAuthTokenCache::getQuotaProject() + + + Get the quota project used for this API request from the credentials +fetcher. + + + + + + + + getProjectId + \Google\Auth\FetchAuthTokenCache::getProjectId() + + + httpHandler + null + callable|null + + + + Get the Project ID from the fetcher. + + + + + + + + + + getUniverseDomain + \Google\Auth\FetchAuthTokenCache::getUniverseDomain() + + + Get the universe domain from the credential. This should always return +a string, and default to "googleapis.com" if no universe domain is +configured. + + + + + + + updateMetadata + \Google\Auth\FetchAuthTokenCache::updateMetadata() + + + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + + fetchAuthTokenFromCache + \Google\Auth\FetchAuthTokenCache::fetchAuthTokenFromCache() + + + authUri + null + string|null + + + + + + + + + + + + + saveAuthTokenInCache + \Google\Auth\FetchAuthTokenCache::saveAuthTokenInCache() + + + authToken + + array + + + + authUri + null + string|null + + + + + + + + + + + + + + getCachedUniverseDomain + \Google\Auth\FetchAuthTokenCache::getCachedUniverseDomain() + + + fetcher + + \Google\Auth\GetUniverseDomainInterface + + + + + + + + + + + getCachedValue + \Google\Auth\CacheTrait::getCachedValue() + + \Google\Auth\CacheTrait + k + + mixed + + + + Gets the cached value if it is present in the cache when that is +available. + + + + + + + + + setCachedValue + \Google\Auth\CacheTrait::setCachedValue() + + \Google\Auth\CacheTrait + k + + mixed + + + + v + + mixed + + + + Saves the value in the cache when that is available. + + + + + + + + + + getFullCacheKey + \Google\Auth\CacheTrait::getFullCacheKey() + + \Google\Auth\CacheTrait + key + + null|string + + + + + + + + + + + + + + + correct caching; update the call to setCachedValue to set the expiry + correct caching; enable the cache to be cleared. + + + + + + + + + + + + + + + + + + + + FetchAuthTokenInterface + \Google\Auth\FetchAuthTokenInterface + + An interface implemented by objects that can fetch auth tokens. + + + + + + fetchAuthToken + \Google\Auth\FetchAuthTokenInterface::fetchAuthToken() + + + httpHandler + null + callable|null + + + + Fetches the auth tokens based on the current state. + + + + + + + + + getCacheKey + \Google\Auth\FetchAuthTokenInterface::getCacheKey() + + + Obtains a key that can used to cache the results of #fetchAuthToken. + If the value is empty, the auth token is not cached. + + + + + + + getLastReceivedToken + \Google\Auth\FetchAuthTokenInterface::getLastReceivedToken() + + + Returns an associative array with the token and +expiration time. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + GCECache + \Google\Auth\GCECache + + A class to implement caching for calls to GCECredentials::onGce. This class +is used automatically when you pass a `Psr\Cache\CacheItemPoolInterface` +cache object to `ApplicationDefaultCredentials::getCredentials`. + ``` +$sysvCache = new Google\Auth\SysvCacheItemPool(); +$creds = Google\Auth\ApplicationDefaultCredentials::getCredentials( + $scope, + null, + null, + $sysvCache +); +``` + + + + + + + GCE_CACHE_KEY + \Google\Auth\GCECache::GCE_CACHE_KEY + 'google_auth_on_gce_cache' + + + + + + + + + + maxKeyLength + \Google\Auth\CacheTrait::$maxKeyLength + 64 + \Google\Auth\CacheTrait + + + + + + + + + cacheConfig + \Google\Auth\CacheTrait::$cacheConfig + + \Google\Auth\CacheTrait + + + + + + + + + cache + \Google\Auth\CacheTrait::$cache + + \Google\Auth\CacheTrait + + + + + + + + + + __construct + \Google\Auth\GCECache::__construct() + + + cacheConfig + null + array + + + + cache + null + \Psr\Cache\CacheItemPoolInterface + + + + + + + + + + + + + onGce + \Google\Auth\GCECache::onGce() + + + httpHandler + null + callable|null + + + + Caches the result of onGce so the metadata server is not called multiple +times. + + + + + + + + + getCachedValue + \Google\Auth\CacheTrait::getCachedValue() + + \Google\Auth\CacheTrait + k + + mixed + + + + Gets the cached value if it is present in the cache when that is +available. + + + + + + + + + setCachedValue + \Google\Auth\CacheTrait::setCachedValue() + + \Google\Auth\CacheTrait + k + + mixed + + + + v + + mixed + + + + Saves the value in the cache when that is available. + + + + + + + + + + getFullCacheKey + \Google\Auth\CacheTrait::getFullCacheKey() + + \Google\Auth\CacheTrait + key + + null|string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + GetQuotaProjectInterface + \Google\Auth\GetQuotaProjectInterface + + An interface implemented by objects that can get quota projects. + + + + + + X_GOOG_USER_PROJECT_HEADER + \Google\Auth\GetQuotaProjectInterface::X_GOOG_USER_PROJECT_HEADER + 'X-Goog-User-Project' + + + + + + + + + getQuotaProject + \Google\Auth\GetQuotaProjectInterface::getQuotaProject() + + + Get the quota project used for this API request + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + GetUniverseDomainInterface + \Google\Auth\GetUniverseDomainInterface + + An interface implemented by objects that can get universe domain for Google Cloud APIs. + + + + + + DEFAULT_UNIVERSE_DOMAIN + \Google\Auth\GetUniverseDomainInterface::DEFAULT_UNIVERSE_DOMAIN + 'googleapis.com' + + + + + + + + + getUniverseDomain + \Google\Auth\GetUniverseDomainInterface::getUniverseDomain() + + + Get the universe domain from the credential. This should always return +a string, and default to "googleapis.com" if no universe domain is +configured. + + + + + + + + + + + + + + + + Copyright 2015 Google Inc. All Rights Reserved. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + Guzzle6HttpHandler + \Google\Auth\HttpHandler\Guzzle6HttpHandler + + + + + + + + + + + client + \Google\Auth\HttpHandler\Guzzle6HttpHandler::$client + + + + + + + + + + + logger + \Google\Auth\HttpHandler\Guzzle6HttpHandler::$logger + + + + + + + + + + + + __construct + \Google\Auth\HttpHandler\Guzzle6HttpHandler::__construct() + + + client + + \GuzzleHttp\ClientInterface + + + + logger + null + null|\Psr\Log\LoggerInterface + + + + + + + + + + + + + __invoke + \Google\Auth\HttpHandler\Guzzle6HttpHandler::__invoke() + + + request + + \Psr\Http\Message\RequestInterface + + + + options + [] + array + + + + Accepts a PSR-7 request and an array of options and returns a PSR-7 response. + + + + + + + + + + async + \Google\Auth\HttpHandler\Guzzle6HttpHandler::async() + + + request + + \Psr\Http\Message\RequestInterface + + + + options + [] + array + + + + Accepts a PSR-7 request and an array of options and returns a PromiseInterface + + + + + + + + + + requestLog + \Google\Auth\HttpHandler\Guzzle6HttpHandler::requestLog() + + + request + + \Psr\Http\Message\RequestInterface + + + + options + + array + + + + + + + + + + + + + + responseLog + \Google\Auth\HttpHandler\Guzzle6HttpHandler::responseLog() + + + response + + \Psr\Http\Message\ResponseInterface + + + + requestEvent + + \Google\Auth\Logging\RpcLogEvent + + + + + + + + + + + + logRequest + \Google\Auth\Logging\LoggingTrait::logRequest() + + \Google\Auth\Logging\LoggingTrait + event + + \Google\Auth\Logging\RpcLogEvent + + + + + + + + + + + + logResponse + \Google\Auth\Logging\LoggingTrait::logResponse() + + \Google\Auth\Logging\LoggingTrait + event + + \Google\Auth\Logging\RpcLogEvent + + + + + + + + + + + + getJwtToken + \Google\Auth\Logging\LoggingTrait::getJwtToken() + + \Google\Auth\Logging\LoggingTrait + headers + + array + + + + + + + + + + + + + truncatePayload + \Google\Auth\Logging\LoggingTrait::truncatePayload() + + \Google\Auth\Logging\LoggingTrait + payload + + null|string + + + + + + + + + + + + + + + + + + + + Copyright 2020 Google LLC + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + Guzzle7HttpHandler + \Google\Auth\HttpHandler\Guzzle7HttpHandler + + + + + + + \Google\Auth\HttpHandler\Guzzle6HttpHandler + + + + + logRequest + \Google\Auth\Logging\LoggingTrait::logRequest() + + \Google\Auth\Logging\LoggingTrait + event + + \Google\Auth\Logging\RpcLogEvent + + + + + + + + + + + + logResponse + \Google\Auth\Logging\LoggingTrait::logResponse() + + \Google\Auth\Logging\LoggingTrait + event + + \Google\Auth\Logging\RpcLogEvent + + + + + + + + + + + + getJwtToken + \Google\Auth\Logging\LoggingTrait::getJwtToken() + + \Google\Auth\Logging\LoggingTrait + headers + + array + + + + + + + + + + + + + truncatePayload + \Google\Auth\Logging\LoggingTrait::truncatePayload() + + \Google\Auth\Logging\LoggingTrait + payload + + null|string + + + + + + + + + + + + + __construct + \Google\Auth\HttpHandler\Guzzle6HttpHandler::__construct() + + \Google\Auth\HttpHandler\Guzzle6HttpHandler + client + + \GuzzleHttp\ClientInterface + + + + logger + null + null|\Psr\Log\LoggerInterface + + + + + + + + + + + + + __invoke + \Google\Auth\HttpHandler\Guzzle6HttpHandler::__invoke() + + \Google\Auth\HttpHandler\Guzzle6HttpHandler + request + + \Psr\Http\Message\RequestInterface + + + + options + [] + array + + + + Accepts a PSR-7 request and an array of options and returns a PSR-7 response. + + + + + + + + + + async + \Google\Auth\HttpHandler\Guzzle6HttpHandler::async() + + \Google\Auth\HttpHandler\Guzzle6HttpHandler + request + + \Psr\Http\Message\RequestInterface + + + + options + [] + array + + + + Accepts a PSR-7 request and an array of options and returns a PromiseInterface + + + + + + + + + + requestLog + \Google\Auth\HttpHandler\Guzzle6HttpHandler::requestLog() + + \Google\Auth\HttpHandler\Guzzle6HttpHandler + request + + \Psr\Http\Message\RequestInterface + + + + options + + array + + + + + + + + + + + + + + responseLog + \Google\Auth\HttpHandler\Guzzle6HttpHandler::responseLog() + + \Google\Auth\HttpHandler\Guzzle6HttpHandler + response + + \Psr\Http\Message\ResponseInterface + + + + requestEvent + + \Google\Auth\Logging\RpcLogEvent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + HttpClientCache + \Google\Auth\HttpHandler\HttpClientCache + + Stores an HTTP Client in order to prevent multiple instantiations. + + + + + + + + + httpClient + \Google\Auth\HttpHandler\HttpClientCache::$httpClient + + + + + + + + + + + + setHttpClient + \Google\Auth\HttpHandler\HttpClientCache::setHttpClient() + + + client + null + \GuzzleHttp\ClientInterface|null + + + + Cache an HTTP Client for later calls. + Passing null will unset the cached client. + + + + + + + + getHttpClient + \Google\Auth\HttpHandler\HttpClientCache::getHttpClient() + + + Get the stored HTTP Client, or null. + + + + + + + + + + + + + + + Copyright 2015 Google Inc. All Rights Reserved. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + HttpHandlerFactory + \Google\Auth\HttpHandler\HttpHandlerFactory + + + + + + + + + + + + build + \Google\Auth\HttpHandler\HttpHandlerFactory::build() + + + client + null + \GuzzleHttp\ClientInterface|null + + + + logger + null + null|false|\Psr\Log\LoggerInterface + + + + Builds out a default http handler for the installed version of guzzle. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Iam + \Google\Auth\Iam + + Tools for using the IAM API. + + + + + + + + + IAM_API_ROOT + \Google\Auth\Iam::IAM_API_ROOT + 'https://iamcredentials.googleapis.com/v1' + + + + + + + + + + SIGN_BLOB_PATH + \Google\Auth\Iam::SIGN_BLOB_PATH + '%s:signBlob?alt=json' + + + + + + + + + SERVICE_ACCOUNT_NAME + \Google\Auth\Iam::SERVICE_ACCOUNT_NAME + 'projects/-/serviceAccounts/%s' + + + + + + + + + IAM_API_ROOT_TEMPLATE + \Google\Auth\Iam::IAM_API_ROOT_TEMPLATE + 'https://iamcredentials.UNIVERSE_DOMAIN/v1' + + + + + + + + + GENERATE_ID_TOKEN_PATH + \Google\Auth\Iam::GENERATE_ID_TOKEN_PATH + '%s:generateIdToken' + + + + + + + + + + httpHandler + \Google\Auth\Iam::$httpHandler + + + + + + + + + + + universeDomain + \Google\Auth\Iam::$universeDomain + + + + + + + + + + + __construct + \Google\Auth\Iam::__construct() + + + httpHandler + null + callable|null + + + + universeDomain + \Google\Auth\GetUniverseDomainInterface::DEFAULT_UNIVERSE_DOMAIN + string + + + + + + + + + + + + signBlob + \Google\Auth\Iam::signBlob() + + + email + + string + + + + accessToken + + string + + + + stringToSign + + string + + + + delegates + [] + string[] + + + + Sign a string using the IAM signBlob API. + Note that signing using IAM requires your service account to have the +`iam.serviceAccounts.signBlob` permission, part of the "Service Account +Token Creator" IAM role. + + + + + + + + + + + generateIdToken + \Google\Auth\Iam::generateIdToken() + + + clientEmail + + string + + + + targetAudience + + string + + + + bearerToken + + string + + + + headers + [] + array<string,string> + + + + Sign a string using the IAM signBlob API. + Note that signing using IAM requires your service account to have the +`iam.serviceAccounts.signBlob` permission, part of the "Service Account +Token Creator" IAM role. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + IamSignerTrait + \Google\Auth\IamSignerTrait + + + + + + + + iam + \Google\Auth\IamSignerTrait::$iam + + + + + + + + + + + + signBlob + \Google\Auth\IamSignerTrait::signBlob() + + + stringToSign + + string + + + + forceOpenSsl + false + bool + + + + accessToken + null + string + + + + Sign a string using the default service account private key. + This implementation uses IAM's signBlob API. + + + + + + + + + + + + + + + + + + Copyright 2024 Google Inc. All Rights Reserved. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + + LoggingTrait + \Google\Auth\Logging\LoggingTrait + + A trait used to call a PSR-3 logging interface. + + + + + + + + logRequest + \Google\Auth\Logging\LoggingTrait::logRequest() + + + event + + \Google\Auth\Logging\RpcLogEvent + + + + + + + + + + + + logResponse + \Google\Auth\Logging\LoggingTrait::logResponse() + + + event + + \Google\Auth\Logging\RpcLogEvent + + + + + + + + + + + + getJwtToken + \Google\Auth\Logging\LoggingTrait::getJwtToken() + + + headers + + array + + + + + + + + + + + + + truncatePayload + \Google\Auth\Logging\LoggingTrait::truncatePayload() + + + payload + + null|string + + + + + + + + + + + + + + + + + + + Copyright 2024 Google Inc. All Rights Reserved. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + RpcLogEvent + \Google\Auth\Logging\RpcLogEvent + + A class that contains all the required information for logging. + + + + + + + + + + timestamp + \Google\Auth\Logging\RpcLogEvent::$timestamp + + + Timestamp in format RFC3339 representing when this event ocurred + + + + + + + + milliseconds + \Google\Auth\Logging\RpcLogEvent::$milliseconds + + + The time in milliseconds at time on creation for calculating latency + + + + + + + + method + \Google\Auth\Logging\RpcLogEvent::$method + null + + Rest method type + + + + + + + + url + \Google\Auth\Logging\RpcLogEvent::$url + null + + URL representing the rest URL endpoint + + + + + + + + headers + \Google\Auth\Logging\RpcLogEvent::$headers + null + + An array that contains the headers for the response or request + + + + + + + + payload + \Google\Auth\Logging\RpcLogEvent::$payload + null + + An array representation of JSON for the response or request + + + + + + + + status + \Google\Auth\Logging\RpcLogEvent::$status + null + + Status code for REST or gRPC methods + + + + + + + + latency + \Google\Auth\Logging\RpcLogEvent::$latency + null + + The latency in milliseconds + + + + + + + + retryAttempt + \Google\Auth\Logging\RpcLogEvent::$retryAttempt + null + + The retry attempt number + + + + + + + + rpcName + \Google\Auth\Logging\RpcLogEvent::$rpcName + null + + The name of the gRPC method being called + + + + + + + + serviceName + \Google\Auth\Logging\RpcLogEvent::$serviceName + null + + The Service Name of the gRPC + + + + + + + + processId + \Google\Auth\Logging\RpcLogEvent::$processId + null + + The Process ID for tracing logs + + + + + + + + requestId + \Google\Auth\Logging\RpcLogEvent::$requestId + null + + The Request id for tracing logs + + + + + + + + + __construct + \Google\Auth\Logging\RpcLogEvent::__construct() + + + startTime + null + null|float + + + + Creates an object with all the fields required for logging +Passing a string representation of a timestamp calculates the difference between +these two times and sets the latency field with the result. + + + + + + + + + + + + + + + Copyright 2024 Google Inc. All Rights Reserved. + Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + + + + + + + + + + + + StdOutLogger + \Google\Auth\Logging\StdOutLogger + + A basic logger class to log into stdOut for GCP logging. + + + + + + + \Psr\Log\LoggerInterface + + + + levelMapping + \Google\Auth\Logging\StdOutLogger::$levelMapping + [\Psr\Log\LogLevel::EMERGENCY => 7, \Psr\Log\LogLevel::ALERT => 6, \Psr\Log\LogLevel::CRITICAL => 5, \Psr\Log\LogLevel::ERROR => 4, \Psr\Log\LogLevel::WARNING => 3, \Psr\Log\LogLevel::NOTICE => 2, \Psr\Log\LogLevel::INFO => 1, \Psr\Log\LogLevel::DEBUG => 0] + + + + + + + + + + level + \Google\Auth\Logging\StdOutLogger::$level + + + + + + + + + + + __construct + \Google\Auth\Logging\StdOutLogger::__construct() + + + level + \Psr\Log\LogLevel::DEBUG + string + + + + Constructs a basic PSR-3 logger class that logs into StdOut for GCP Logging + + + + + + + + log + \Google\Auth\Logging\StdOutLogger::log() + + + level + + mixed + + + + message + + string|\Stringable + + + + context + [] + array + + + + {@inheritdoc} + + + + + + + getLevelFromName + \Google\Auth\Logging\StdOutLogger::getLevelFromName() + + + levelName + + string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + MetricsTrait + \Google\Auth\MetricsTrait + + Trait containing helper methods required for enabling +observability metrics in the library. + + + + + + + version + \Google\Auth\MetricsTrait::$version + + + + + + + + + + + metricMetadataKey + \Google\Auth\MetricsTrait::$metricMetadataKey + 'x-goog-api-client' + + + + + + + + + + + getMetricsHeader + \Google\Auth\MetricsTrait::getMetricsHeader() + + + credType + '' + string + + + + authRequestType + '' + string + + + + + + + + + + + + + + applyServiceApiUsageMetrics + \Google\Auth\MetricsTrait::applyServiceApiUsageMetrics() + + + metadata + + array + + + + + + + + + + + + + applyTokenEndpointMetrics + \Google\Auth\MetricsTrait::applyTokenEndpointMetrics() + + + metadata + + array + + + + authRequestType + + string + + + + + + + + + + + + + + getVersion + \Google\Auth\MetricsTrait::getVersion() + + + + + + + + + + getCredType + \Google\Auth\MetricsTrait::getCredType() + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AuthTokenMiddleware + \Google\Auth\Middleware\AuthTokenMiddleware + + AuthTokenMiddleware is a Guzzle Middleware that adds an Authorization header +provided by an object implementing FetchAuthTokenInterface. + The FetchAuthTokenInterface#fetchAuthToken is used to obtain a hash; one of +the values value in that hash is added as the authorization header. + +Requests will be accessed with the authorization header: + +'authorization' 'Bearer <value of auth_token>' + + + + + + + + httpHandler + \Google\Auth\Middleware\AuthTokenMiddleware::$httpHandler + + + + + + + + + + + fetcher + \Google\Auth\Middleware\AuthTokenMiddleware::$fetcher + + + It must be an implementation of FetchAuthTokenInterface. + It may also implement UpdateMetadataInterface allowing direct +retrieval of auth related headers + + + + + + + tokenCallback + \Google\Auth\Middleware\AuthTokenMiddleware::$tokenCallback + + + + + + + + + + + + __construct + \Google\Auth\Middleware\AuthTokenMiddleware::__construct() + + + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + httpHandler + null + callable|null + + + + tokenCallback + null + callable|null + + + + Creates a new AuthTokenMiddleware. + + + + + + + + + + __invoke + \Google\Auth\Middleware\AuthTokenMiddleware::__invoke() + + + handler + + callable + + + + Updates the request with an Authorization header when auth is 'google_auth'. + use Google\Auth\Middleware\AuthTokenMiddleware; +use Google\Auth\OAuth2; +use GuzzleHttp\Client; +use GuzzleHttp\HandlerStack; + +$config = [..<oauth config param>.]; +$oauth2 = new OAuth2($config) +$middleware = new AuthTokenMiddleware($oauth2); +$stack = HandlerStack::create(); +$stack->push($middleware); + +$client = new Client([ + 'handler' => $stack, + 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', + 'auth' => 'google_auth' // authorize all requests +]); + +$res = $client->get('myproject/taskqueues/myqueue'); + + + + + + + + addAuthHeaders + \Google\Auth\Middleware\AuthTokenMiddleware::addAuthHeaders() + + + request + + \Psr\Http\Message\RequestInterface + + + + Adds auth related headers to the request. + + + + + + + + + getQuotaProject + \Google\Auth\Middleware\AuthTokenMiddleware::getQuotaProject() + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ProxyAuthTokenMiddleware + \Google\Auth\Middleware\ProxyAuthTokenMiddleware + + ProxyAuthTokenMiddleware is a Guzzle Middleware that adds an Authorization header +provided by an object implementing FetchAuthTokenInterface. + The FetchAuthTokenInterface#fetchAuthToken is used to obtain a hash; one of +the values value in that hash is added as the authorization header. + +Requests will be accessed with the authorization header: + +'proxy-authorization' 'Bearer <value of auth_token>' + + + + + + + + httpHandler + \Google\Auth\Middleware\ProxyAuthTokenMiddleware::$httpHandler + + + + + + + + + + + fetcher + \Google\Auth\Middleware\ProxyAuthTokenMiddleware::$fetcher + + + + + + + + + + + tokenCallback + \Google\Auth\Middleware\ProxyAuthTokenMiddleware::$tokenCallback + + + + + + + + + + + + __construct + \Google\Auth\Middleware\ProxyAuthTokenMiddleware::__construct() + + + fetcher + + \Google\Auth\FetchAuthTokenInterface + + + + httpHandler + null + callable|null + + + + tokenCallback + null + callable|null + + + + Creates a new ProxyAuthTokenMiddleware. + + + + + + + + + + __invoke + \Google\Auth\Middleware\ProxyAuthTokenMiddleware::__invoke() + + + handler + + callable + + + + Updates the request with an Authorization header when auth is 'google_auth'. + use Google\Auth\Middleware\ProxyAuthTokenMiddleware; +use Google\Auth\OAuth2; +use GuzzleHttp\Client; +use GuzzleHttp\HandlerStack; + +$config = [..<oauth config param>.]; +$oauth2 = new OAuth2($config) +$middleware = new ProxyAuthTokenMiddleware($oauth2); +$stack = HandlerStack::create(); +$stack->push($middleware); + +$client = new Client([ + 'handler' => $stack, + 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', + 'proxy_auth' => 'google_auth' // authorize all requests +]); + +$res = $client->get('myproject/taskqueues/myqueue'); + + + + + + + + fetchToken + \Google\Auth\Middleware\ProxyAuthTokenMiddleware::fetchToken() + + + Call fetcher to fetch the token. + + + + + + + + getQuotaProject + \Google\Auth\Middleware\ProxyAuthTokenMiddleware::getQuotaProject() + + + + + + + + + + + + + + Tag "@return" with body "@@return string|null;" has error + + + + + + + + + + + + + + + + + + + + ScopedAccessTokenMiddleware + \Google\Auth\Middleware\ScopedAccessTokenMiddleware + + ScopedAccessTokenMiddleware is a Guzzle Middleware that adds an Authorization +header provided by a closure. + The closure returns an access token, taking the scope, either a single +string or an array of strings, as its value. If provided, a cache will be +used to preserve the access token for a given lifetime. + +Requests will be accessed with the authorization header: + +'authorization' 'Bearer <value of auth_token>' + + + + + + + DEFAULT_CACHE_LIFETIME + \Google\Auth\Middleware\ScopedAccessTokenMiddleware::DEFAULT_CACHE_LIFETIME + 1500 + + + + + + + + + + tokenFunc + \Google\Auth\Middleware\ScopedAccessTokenMiddleware::$tokenFunc + + + + + + + + + + + scopes + \Google\Auth\Middleware\ScopedAccessTokenMiddleware::$scopes + + + + + + + + + + + maxKeyLength + \Google\Auth\CacheTrait::$maxKeyLength + 64 + \Google\Auth\CacheTrait + + + + + + + + + cacheConfig + \Google\Auth\CacheTrait::$cacheConfig + + \Google\Auth\CacheTrait + + + + + + + + + cache + \Google\Auth\CacheTrait::$cache + + \Google\Auth\CacheTrait + + + + + + + + + + __construct + \Google\Auth\Middleware\ScopedAccessTokenMiddleware::__construct() + + + tokenFunc + + callable + + + + scopes + + string[]|string + + + + cacheConfig + null + array|null + + + + cache + null + \Psr\Cache\CacheItemPoolInterface|null + + + + Creates a new ScopedAccessTokenMiddleware. + + + + + + + + + + + __invoke + \Google\Auth\Middleware\ScopedAccessTokenMiddleware::__invoke() + + + handler + + callable + + + + Updates the request with an Authorization header when auth is 'scoped'. + E.g this could be used to authenticate using the AppEngine +AppIdentityService. + +use google\appengine\api\app_identity\AppIdentityService; +use Google\Auth\Middleware\ScopedAccessTokenMiddleware; +use GuzzleHttp\Client; +use GuzzleHttp\HandlerStack; + +$scope = 'https://www.googleapis.com/auth/taskqueue' +$middleware = new ScopedAccessTokenMiddleware( + 'AppIdentityService::getAccessToken', + $scope, + [ 'prefix' => 'Google\Auth\ScopedAccessToken::' ], + $cache = new Memcache() +); +$stack = HandlerStack::create(); +$stack->push($middleware); + +$client = new Client([ + 'handler' => $stack, + 'base_url' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', + 'auth' => 'scoped' // authorize all requests +]); + +$res = $client->get('myproject/taskqueues/myqueue'); + + + + + + + + getCacheKey + \Google\Auth\Middleware\ScopedAccessTokenMiddleware::getCacheKey() + + + + + + + + + + + fetchToken + \Google\Auth\Middleware\ScopedAccessTokenMiddleware::fetchToken() + + + Determine if token is available in the cache, if not call tokenFunc to +fetch it. + + + + + + + + getCachedValue + \Google\Auth\CacheTrait::getCachedValue() + + \Google\Auth\CacheTrait + k + + mixed + + + + Gets the cached value if it is present in the cache when that is +available. + + + + + + + + + setCachedValue + \Google\Auth\CacheTrait::setCachedValue() + + \Google\Auth\CacheTrait + k + + mixed + + + + v + + mixed + + + + Saves the value in the cache when that is available. + + + + + + + + + + getFullCacheKey + \Google\Auth\CacheTrait::getFullCacheKey() + + \Google\Auth\CacheTrait + key + + null|string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + SimpleMiddleware + \Google\Auth\Middleware\SimpleMiddleware + + SimpleMiddleware is a Guzzle Middleware that implements Google's Simple API +access. + Requests are accessed using the Simple API access developer key. + + + + + + + + config + \Google\Auth\Middleware\SimpleMiddleware::$config + + + + + + + + + + + + __construct + \Google\Auth\Middleware\SimpleMiddleware::__construct() + + + config + + array + + + + Create a new Simple plugin. + The configuration array expects one option +- key: required, otherwise InvalidArgumentException is thrown + + + + + + + __invoke + \Google\Auth\Middleware\SimpleMiddleware::__invoke() + + + handler + + callable + + + + Updates the request query with the developer key if auth is set to simple. + use Google\Auth\Middleware\SimpleMiddleware; +use GuzzleHttp\Client; +use GuzzleHttp\HandlerStack; + +$my_key = 'is not the same as yours'; +$middleware = new SimpleMiddleware(['key' => $my_key]); +$stack = HandlerStack::create(); +$stack->push($middleware); + +$client = new Client([ + 'handler' => $stack, + 'base_uri' => 'https://www.googleapis.com/discovery/v1/', + 'auth' => 'simple' +]); + +$res = $client->get('drive/v2/rest'); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + OAuth2 + \Google\Auth\OAuth2 + + OAuth2 supports authentication by OAuth2 2-legged flows. + It primary supports +- service account authorization +- authorization where a user already has an access token + + + + + \Google\Auth\FetchAuthTokenInterface + + + DEFAULT_EXPIRY_SECONDS + \Google\Auth\OAuth2::DEFAULT_EXPIRY_SECONDS + 3600 + + + + + + + + + DEFAULT_SKEW_SECONDS + \Google\Auth\OAuth2::DEFAULT_SKEW_SECONDS + 60 + + + + + + + + + JWT_URN + \Google\Auth\OAuth2::JWT_URN + 'urn:ietf:params:oauth:grant-type:jwt-bearer' + + + + + + + + + STS_URN + \Google\Auth\OAuth2::STS_URN + 'urn:ietf:params:oauth:grant-type:token-exchange' + + + + + + + + + STS_REQUESTED_TOKEN_TYPE + \Google\Auth\OAuth2::STS_REQUESTED_TOKEN_TYPE + 'urn:ietf:params:oauth:token-type:access_token' + + + + + + + + + + knownSigningAlgorithms + \Google\Auth\OAuth2::$knownSigningAlgorithms + ['HS256', 'HS512', 'HS384', 'RS256'] + + TODO: determine known methods from the keys of JWT::methods. + + + + + + + + knownGrantTypes + \Google\Auth\OAuth2::$knownGrantTypes + ['authorization_code', 'refresh_token', 'password', 'client_credentials'] + + The well known grant types. + + + + + + + + authorizationUri + \Google\Auth\OAuth2::$authorizationUri + + + - authorizationUri + The authorization server's HTTP endpoint capable of + authenticating the end-user and obtaining authorization. + + + + + + + + tokenCredentialUri + \Google\Auth\OAuth2::$tokenCredentialUri + + + - tokenCredentialUri + The authorization server's HTTP endpoint capable of issuing + tokens and refreshing expired tokens. + + + + + + + + redirectUri + \Google\Auth\OAuth2::$redirectUri + + + The redirection URI used in the initial request. + + + + + + + + clientId + \Google\Auth\OAuth2::$clientId + + + A unique identifier issued to the client to identify itself to the +authorization server. + + + + + + + + clientSecret + \Google\Auth\OAuth2::$clientSecret + + + A shared symmetric secret issued by the authorization server, which is +used to authenticate the client. + + + + + + + + username + \Google\Auth\OAuth2::$username + + + The resource owner's username. + + + + + + + + password + \Google\Auth\OAuth2::$password + + + The resource owner's password. + + + + + + + + scope + \Google\Auth\OAuth2::$scope + + + The scope of the access request, expressed either as an Array or as a +space-delimited string. + + + + + + + + state + \Google\Auth\OAuth2::$state + + + An arbitrary string designed to allow the client to maintain state. + + + + + + + + code + \Google\Auth\OAuth2::$code + + + The authorization code issued to this client. + Only used by the authorization code access grant type. + + + + + + + issuer + \Google\Auth\OAuth2::$issuer + + + The issuer ID when using assertion profile. + + + + + + + + audience + \Google\Auth\OAuth2::$audience + + + The target audience for assertions. + + + + + + + + sub + \Google\Auth\OAuth2::$sub + + + The target sub when issuing assertions. + + + + + + + + expiry + \Google\Auth\OAuth2::$expiry + + + The number of seconds assertions are valid for. + + + + + + + + signingKey + \Google\Auth\OAuth2::$signingKey + + + The signing key when using assertion profile. + + + + + + + + signingKeyId + \Google\Auth\OAuth2::$signingKeyId + + + The signing key id when using assertion profile. Param kid in jwt header + + + + + + + + signingAlgorithm + \Google\Auth\OAuth2::$signingAlgorithm + + + The signing algorithm when using an assertion profile. + + + + + + + + refreshToken + \Google\Auth\OAuth2::$refreshToken + + + The refresh token associated with the access token to be refreshed. + + + + + + + + accessToken + \Google\Auth\OAuth2::$accessToken + + + The current access token. + + + + + + + + idToken + \Google\Auth\OAuth2::$idToken + + + The current ID token. + + + + + + + + grantedScope + \Google\Auth\OAuth2::$grantedScope + + + The scopes granted to the current access token + + + + + + + + expiresIn + \Google\Auth\OAuth2::$expiresIn + + + The lifetime in seconds of the current access token. + + + + + + + + expiresAt + \Google\Auth\OAuth2::$expiresAt + + + The expiration time of the access token as a number of seconds since the +unix epoch. + + + + + + + + issuedAt + \Google\Auth\OAuth2::$issuedAt + + + The issue time of the access token as a number of seconds since the unix +epoch. + + + + + + + + grantType + \Google\Auth\OAuth2::$grantType + + + The current grant type. + + + + + + + + extensionParams + \Google\Auth\OAuth2::$extensionParams + + + When using an extension grant type, this is the set of parameters used by +that extension. + + + + + + + + additionalClaims + \Google\Auth\OAuth2::$additionalClaims + + + When using the toJwt function, these claims will be added to the JWT +payload. + + + + + + + + codeVerifier + \Google\Auth\OAuth2::$codeVerifier + + + The code verifier for PKCE for OAuth 2.0. When set, the authorization +URI will contain the Code Challenge and Code Challenge Method querystring +parameters, and the token URI will contain the Code Verifier parameter. + + + + + + + + + resource + \Google\Auth\OAuth2::$resource + + + For STS requests. + A URI that indicates the target service or resource where the client +intends to use the requested security token. + + + + + + subjectTokenFetcher + \Google\Auth\OAuth2::$subjectTokenFetcher + + + For STS requests. + A fetcher for the "subject_token", which is a security token that +represents the identity of the party on behalf of whom the request is +being made. + + + + + + subjectTokenType + \Google\Auth\OAuth2::$subjectTokenType + + + For STS requests. + An identifier, that indicates the type of the security token in the +subjectToken parameter. + + + + + + actorToken + \Google\Auth\OAuth2::$actorToken + + + For STS requests. + A security token that represents the identity of the acting party. + + + + + + actorTokenType + \Google\Auth\OAuth2::$actorTokenType + + + For STS requests. + An identifier that indicates the type of the security token in the +actorToken parameter. + + + + + + issuedTokenType + \Google\Auth\OAuth2::$issuedTokenType + null + + From STS response. + An identifier for the representation of the issued security token. + + + + + + additionalOptions + \Google\Auth\OAuth2::$additionalOptions + + + From STS response. + An identifier for the representation of the issued security token. + + + + + + + + __construct + \Google\Auth\OAuth2::__construct() + + + config + + array + + + + Create a new OAuthCredentials. + The configuration array accepts various options + +- authorizationUri + The authorization server's HTTP endpoint capable of + authenticating the end-user and obtaining authorization. + +- tokenCredentialUri + The authorization server's HTTP endpoint capable of issuing + tokens and refreshing expired tokens. + +- clientId + A unique identifier issued to the client to identify itself to the + authorization server. + +- clientSecret + A shared symmetric secret issued by the authorization server, + which is used to authenticate the client. + +- scope + The scope of the access request, expressed either as an Array + or as a space-delimited String. + +- state + An arbitrary string designed to allow the client to maintain state. + +- redirectUri + The redirection URI used in the initial request. + +- username + The resource owner's username. + +- password + The resource owner's password. + +- issuer + Issuer ID when using assertion profile + +- audience + Target audience for assertions + +- expiry + Number of seconds assertions are valid for + +- signingKey + Signing key when using assertion profile + +- signingKeyId + Signing key id when using assertion profile + +- refreshToken + The refresh token associated with the access token + to be refreshed. + +- accessToken + The current access token for this client. + +- idToken + The current ID token for this client. + +- extensionParams + When using an extension grant type, this is the set of parameters used + by that extension. + +- codeVerifier + The code verifier for PKCE for OAuth 2.0. + +- resource + The target service or resource where the client ntends to use the + requested security token. + +- subjectTokenFetcher + A fetcher for the "subject_token", which is a security token that + represents the identity of the party on behalf of whom the request is + being made. + +- subjectTokenType + An identifier that indicates the type of the security token in the + subjectToken parameter. + +- actorToken + A security token that represents the identity of the acting party. + +- actorTokenType + An identifier for the representation of the issued security token. + + + + + + + verifyIdToken + \Google\Auth\OAuth2::verifyIdToken() + + + publicKey + null + string|\Firebase\JWT\Key|\Firebase\JWT\Key[] + + + + allowed_algs + [] + string|string[] + + + + Verifies the idToken if present. + - if none is present, return null +- if present, but invalid, raises DomainException. +- otherwise returns the payload in the idtoken as a PHP object. + +The behavior of this method varies depending on the version of +`firebase/php-jwt` you are using. In versions 6.0 and above, you cannot +provide multiple $allowed_algs, and instead must provide an array of Key +objects as the $publicKey. + + + + + + + + + + + + + + + + toJwt + \Google\Auth\OAuth2::toJwt() + + + config + [] + array + + + + Obtains the encoded jwt from the instance data. + + + + + + + + + generateCredentialsRequest + \Google\Auth\OAuth2::generateCredentialsRequest() + + + httpHandler + null + callable|null + + + + headers + [] + array + + + + Generates a request for token credentials. + + + + + + + + + + fetchAuthToken + \Google\Auth\OAuth2::fetchAuthToken() + + + httpHandler + null + callable|null + + + + headers + [] + array + + + + Fetches the auth tokens based on the current state. + + + + + + + + + + getCacheKey + \Google\Auth\OAuth2::getCacheKey() + + + Obtains a key that can used to cache the results of #fetchAuthToken. + + + + + + + + + getSubjectTokenFetcher + \Google\Auth\OAuth2::getSubjectTokenFetcher() + + + Gets this instance's SubjectTokenFetcher + + + + + + + + parseTokenResponse + \Google\Auth\OAuth2::parseTokenResponse() + + + resp + + \Psr\Http\Message\ResponseInterface + + + + Parses the fetched tokens. + + + + + + + + + + updateToken + \Google\Auth\OAuth2::updateToken() + + + config + + array + + + + Updates an OAuth 2.0 client. + Example: +``` +$oauth->updateToken([ + 'refresh_token' => 'n4E9O119d', + 'access_token' => 'FJQbwq9', + 'expires_in' => 3600 +]); +``` + + + + + + + + buildFullAuthorizationUri + \Google\Auth\OAuth2::buildFullAuthorizationUri() + + + config + [] + array + + + + Builds the authorization Uri that the user should be redirected to. + + + + + + + + + + getCodeVerifier + \Google\Auth\OAuth2::getCodeVerifier() + + + + + + + + + + + setCodeVerifier + \Google\Auth\OAuth2::setCodeVerifier() + + + codeVerifier + + string|null + + + + A cryptographically random string that is used to correlate the +authorization request to the token request. + The code verifier for PKCE for OAuth 2.0. When set, the authorization +URI will contain the Code Challenge and Code Challenge Method querystring +parameters, and the token URI will contain the Code Verifier parameter. + + + + + + + + generateCodeVerifier + \Google\Auth\OAuth2::generateCodeVerifier() + + + Generates a random 128-character string for the "code_verifier" parameter +in PKCE for OAuth 2.0. This is a cryptographically random string that is +determined using random_int, hashed using "hash" and sha256, and base64 +encoded. + When this method is called, the code verifier is set on the object. + + + + + + + getCodeChallenge + \Google\Auth\OAuth2::getCodeChallenge() + + + randomString + + string + + + + + + + + + + + getCodeChallengeMethod + \Google\Auth\OAuth2::getCodeChallengeMethod() + + + + + + + + + + generateRandomString + \Google\Auth\OAuth2::generateRandomString() + + + length + + int + + + + + + + + + + + setAuthorizationUri + \Google\Auth\OAuth2::setAuthorizationUri() + + + uri + + string + + + + Sets the authorization server's HTTP endpoint capable of authenticating +the end-user and obtaining authorization. + + + + + + + + + getAuthorizationUri + \Google\Auth\OAuth2::getAuthorizationUri() + + + Gets the authorization server's HTTP endpoint capable of authenticating +the end-user and obtaining authorization. + + + + + + + + getTokenCredentialUri + \Google\Auth\OAuth2::getTokenCredentialUri() + + + Gets the authorization server's HTTP endpoint capable of issuing tokens +and refreshing expired tokens. + + + + + + + + setTokenCredentialUri + \Google\Auth\OAuth2::setTokenCredentialUri() + + + uri + + string + + + + Sets the authorization server's HTTP endpoint capable of issuing tokens +and refreshing expired tokens. + + + + + + + + + getRedirectUri + \Google\Auth\OAuth2::getRedirectUri() + + + Gets the redirection URI used in the initial request. + + + + + + + + setRedirectUri + \Google\Auth\OAuth2::setRedirectUri() + + + uri + + ?string + + + + Sets the redirection URI used in the initial request. + + + + + + + + + getScope + \Google\Auth\OAuth2::getScope() + + + Gets the scope of the access requests as a space-delimited String. + + + + + + + + getSubjectTokenType + \Google\Auth\OAuth2::getSubjectTokenType() + + + Gets the subject token type + + + + + + + + setScope + \Google\Auth\OAuth2::setScope() + + + scope + + string|string[]|null + + + + Sets the scope of the access request, expressed either as an Array or as +a space-delimited String. + + + + + + + + + + getGrantType + \Google\Auth\OAuth2::getGrantType() + + + Gets the current grant type. + + + + + + + + setGrantType + \Google\Auth\OAuth2::setGrantType() + + + grantType + + string + + + + Sets the current grant type. + + + + + + + + + + getState + \Google\Auth\OAuth2::getState() + + + Gets an arbitrary string designed to allow the client to maintain state. + + + + + + + + setState + \Google\Auth\OAuth2::setState() + + + state + + string + + + + Sets an arbitrary string designed to allow the client to maintain state. + + + + + + + + + getCode + \Google\Auth\OAuth2::getCode() + + + Gets the authorization code issued to this client. + + + + + + + + setCode + \Google\Auth\OAuth2::setCode() + + + code + + string + + + + Sets the authorization code issued to this client. + + + + + + + + + getUsername + \Google\Auth\OAuth2::getUsername() + + + Gets the resource owner's username. + + + + + + + + setUsername + \Google\Auth\OAuth2::setUsername() + + + username + + string + + + + Sets the resource owner's username. + + + + + + + + + getPassword + \Google\Auth\OAuth2::getPassword() + + + Gets the resource owner's password. + + + + + + + + setPassword + \Google\Auth\OAuth2::setPassword() + + + password + + string + + + + Sets the resource owner's password. + + + + + + + + + getClientId + \Google\Auth\OAuth2::getClientId() + + + Sets a unique identifier issued to the client to identify itself to the +authorization server. + + + + + + + + setClientId + \Google\Auth\OAuth2::setClientId() + + + clientId + + string + + + + Sets a unique identifier issued to the client to identify itself to the +authorization server. + + + + + + + + + getClientSecret + \Google\Auth\OAuth2::getClientSecret() + + + Gets a shared symmetric secret issued by the authorization server, which +is used to authenticate the client. + + + + + + + + setClientSecret + \Google\Auth\OAuth2::setClientSecret() + + + clientSecret + + string + + + + Sets a shared symmetric secret issued by the authorization server, which +is used to authenticate the client. + + + + + + + + + getIssuer + \Google\Auth\OAuth2::getIssuer() + + + Gets the Issuer ID when using assertion profile. + + + + + + + + setIssuer + \Google\Auth\OAuth2::setIssuer() + + + issuer + + string + + + + Sets the Issuer ID when using assertion profile. + + + + + + + + + getSub + \Google\Auth\OAuth2::getSub() + + + Gets the target sub when issuing assertions. + + + + + + + + setSub + \Google\Auth\OAuth2::setSub() + + + sub + + string + + + + Sets the target sub when issuing assertions. + + + + + + + + + getAudience + \Google\Auth\OAuth2::getAudience() + + + Gets the target audience when issuing assertions. + + + + + + + + setAudience + \Google\Auth\OAuth2::setAudience() + + + audience + + string + + + + Sets the target audience when issuing assertions. + + + + + + + + + getSigningKey + \Google\Auth\OAuth2::getSigningKey() + + + Gets the signing key when using an assertion profile. + + + + + + + + setSigningKey + \Google\Auth\OAuth2::setSigningKey() + + + signingKey + + string + + + + Sets the signing key when using an assertion profile. + + + + + + + + + getSigningKeyId + \Google\Auth\OAuth2::getSigningKeyId() + + + Gets the signing key id when using an assertion profile. + + + + + + + + setSigningKeyId + \Google\Auth\OAuth2::setSigningKeyId() + + + signingKeyId + + string + + + + Sets the signing key id when using an assertion profile. + + + + + + + + + getSigningAlgorithm + \Google\Auth\OAuth2::getSigningAlgorithm() + + + Gets the signing algorithm when using an assertion profile. + + + + + + + + setSigningAlgorithm + \Google\Auth\OAuth2::setSigningAlgorithm() + + + signingAlgorithm + + ?string + + + + Sets the signing algorithm when using an assertion profile. + + + + + + + + + getExtensionParams + \Google\Auth\OAuth2::getExtensionParams() + + + Gets the set of parameters used by extension when using an extension +grant type. + + + + + + + + setExtensionParams + \Google\Auth\OAuth2::setExtensionParams() + + + extensionParams + + array + + + + Sets the set of parameters used by extension when using an extension +grant type. + + + + + + + + + getExpiry + \Google\Auth\OAuth2::getExpiry() + + + Gets the number of seconds assertions are valid for. + + + + + + + + setExpiry + \Google\Auth\OAuth2::setExpiry() + + + expiry + + int + + + + Sets the number of seconds assertions are valid for. + + + + + + + + + getExpiresIn + \Google\Auth\OAuth2::getExpiresIn() + + + Gets the lifetime of the access token in seconds. + + + + + + + + setExpiresIn + \Google\Auth\OAuth2::setExpiresIn() + + + expiresIn + + ?int + + + + Sets the lifetime of the access token in seconds. + + + + + + + + + getExpiresAt + \Google\Auth\OAuth2::getExpiresAt() + + + Gets the time the current access token expires at. + + + + + + + + isExpired + \Google\Auth\OAuth2::isExpired() + + + Returns true if the acccess token has expired. + + + + + + + + setExpiresAt + \Google\Auth\OAuth2::setExpiresAt() + + + expiresAt + + int + + + + Sets the time the current access token expires at. + + + + + + + + + getIssuedAt + \Google\Auth\OAuth2::getIssuedAt() + + + Gets the time the current access token was issued at. + + + + + + + + setIssuedAt + \Google\Auth\OAuth2::setIssuedAt() + + + issuedAt + + int + + + + Sets the time the current access token was issued at. + + + + + + + + + getAccessToken + \Google\Auth\OAuth2::getAccessToken() + + + Gets the current access token. + + + + + + + + setAccessToken + \Google\Auth\OAuth2::setAccessToken() + + + accessToken + + string + + + + Sets the current access token. + + + + + + + + + getIdToken + \Google\Auth\OAuth2::getIdToken() + + + Gets the current ID token. + + + + + + + + setIdToken + \Google\Auth\OAuth2::setIdToken() + + + idToken + + string + + + + Sets the current ID token. + + + + + + + + + getGrantedScope + \Google\Auth\OAuth2::getGrantedScope() + + + Get the granted space-separated scopes (if they exist) for the last +fetched token. + + + + + + + + setGrantedScope + \Google\Auth\OAuth2::setGrantedScope() + + + grantedScope + + string + + + + Sets the current ID token. + + + + + + + + + getRefreshToken + \Google\Auth\OAuth2::getRefreshToken() + + + Gets the refresh token associated with the current access token. + + + + + + + + setRefreshToken + \Google\Auth\OAuth2::setRefreshToken() + + + refreshToken + + string + + + + Sets the refresh token associated with the current access token. + + + + + + + + + setAdditionalClaims + \Google\Auth\OAuth2::setAdditionalClaims() + + + additionalClaims + + array + + + + Sets additional claims to be included in the JWT token + + + + + + + + + getAdditionalClaims + \Google\Auth\OAuth2::getAdditionalClaims() + + + Gets the additional claims to be included in the JWT token. + + + + + + + + getIssuedTokenType + \Google\Auth\OAuth2::getIssuedTokenType() + + + Gets the additional claims to be included in the JWT token. + + + + + + + + getLastReceivedToken + \Google\Auth\OAuth2::getLastReceivedToken() + + + The expiration of the last received token. + + + + + + + + getClientName + \Google\Auth\OAuth2::getClientName() + + + httpHandler + null + callable|null + + + + Get the client ID. + Alias of {@see \Google\Auth\OAuth2::getClientId()}. + + + + + + + + + coerceUri + \Google\Auth\OAuth2::coerceUri() + + + uri + + ?string + + + + + + + + + + + + + + jwtDecode + \Google\Auth\OAuth2::jwtDecode() + + + idToken + + string + + + + publicKey + + \Firebase\JWT\Key|\Firebase\JWT\Key[]|string|string[] + + + + allowedAlgs + + string|string[] + + + + + + + + + + + + + + + getFirebaseJwtKeys + \Google\Auth\OAuth2::getFirebaseJwtKeys() + + + publicKey + + \Firebase\JWT\Key|\Firebase\JWT\Key[]|string|string[] + + + + allowedAlgs + + string|string[] + + + + + + + + + + + + + + isAbsoluteUri + \Google\Auth\OAuth2::isAbsoluteUri() + + + uri + + string + + + + Determines if the URI is absolute based on its scheme and host or path +(RFC 3986). + + + + + + + + + addClientCredentials + \Google\Auth\OAuth2::addClientCredentials() + + + params + + array + + + + + + + + + + + + + + + handle uri as array + + + + + + + + + + + + + + + + + + + + ProjectIdProviderInterface + \Google\Auth\ProjectIdProviderInterface + + Describes a Credentials object which supports fetching the project ID. + + + + + + getProjectId + \Google\Auth\ProjectIdProviderInterface::getProjectId() + + + httpHandler + null + callable|null + + + + Get the project ID. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ServiceAccountSignerTrait + \Google\Auth\ServiceAccountSignerTrait + + Sign a string using a Service Account private key. + + + + + + + signBlob + \Google\Auth\ServiceAccountSignerTrait::signBlob() + + + stringToSign + + string + + + + forceOpenssl + false + bool + + + + Sign a string using the service account private key. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + SignBlobInterface + \Google\Auth\SignBlobInterface + + Describes a class which supports signing arbitrary strings. + + + + + \Google\Auth\FetchAuthTokenInterface + + signBlob + \Google\Auth\SignBlobInterface::signBlob() + + + stringToSign + + string + + + + forceOpenssl + false + bool + + + + Sign a string using the method which is best for a given credentials type. + + + + + + + + + + getClientName + \Google\Auth\SignBlobInterface::getClientName() + + + httpHandler + null + callable|null + + + + Returns the current Client Name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + UpdateMetadataInterface + \Google\Auth\UpdateMetadataInterface + + Describes a Credentials object which supports updating request metadata +(request headers). + + + + + + AUTH_METADATA_KEY + \Google\Auth\UpdateMetadataInterface::AUTH_METADATA_KEY + 'authorization' + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataInterface::updateMetadata() + + + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + UpdateMetadataTrait + \Google\Auth\UpdateMetadataTrait + + Provides shared methods for updating request metadata (request headers). + Should implement {@see \Google\Auth\UpdateMetadataInterface} and {@see \Google\Auth\FetchAuthTokenInterface}. + + + + + + + getUpdateMetadataFunc + \Google\Auth\UpdateMetadataTrait::getUpdateMetadataFunc() + + + export a callback function which updates runtime metadata. + + + + + + + + + updateMetadata + \Google\Auth\UpdateMetadataTrait::updateMetadata() + + + metadata + + array + + + + authUri + null + string + + + + httpHandler + null + callable|null + + + + Updates metadata with the authorization token. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/dev/tests/fixtures/phpdoc/structure.xml b/dev/tests/fixtures/phpdoc/vision.xml similarity index 64% rename from dev/tests/fixtures/phpdoc/structure.xml rename to dev/tests/fixtures/phpdoc/vision.xml index 0b59072ee8f9..890239b31286 100644 --- a/dev/tests/fixtures/phpdoc/structure.xml +++ b/dev/tests/fixtures/phpdoc/vision.xml @@ -1,19 +1,9 @@ - + - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - AbstractFeature - \Google\Cloud\Vision\Annotation\AbstractFeature - - Provide shared functionality for features - + + + AddProductToProductSetRequest + \Google\Cloud\Vision\V1\AddProductToProductSetRequest + + Request message for the `AddProductToProductSet` method. + Generated from protobuf message <code>google.cloud.vision.v1.AddProductToProductSetRequest</code> - + \Google\Protobuf\Internal\Message - \Google\Cloud\Vision\Annotation\FeatureInterface - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - - - - - - - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() - - - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` - - - - - - - - - - - - - - - Copyright 2016 Google Inc. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at + + name + \Google\Cloud\Vision\V1\AddProductToProductSetRequest::$name + '' + + Required. The resource name for the ProductSet to modify. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - http://www.apache.org/licenses/LICENSE-2.0 +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - + + + product + \Google\Cloud\Vision\V1\AddProductToProductSetRequest::$product + '' + + Required. The resource name for the Product to be added to this ProductSet. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - - - +Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + - - - - - CropHint - \Google\Cloud\Vision\Annotation\CropHint - - Represents a recommended image crop. - Example: -``` -use Google\Cloud\Vision\VisionClient; + -$vision = new VisionClient(); + + + build + \Google\Cloud\Vision\V1\AddProductToProductSetRequest::build() + + + name + + string + -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = $vision->image($imageResource, [ 'CROP_HINTS' ]); -$annotation = $vision->annotate($image); + + product + + string + -$hints = $annotation->cropHints(); -$hint = $hints[0]; -``` + + + - + name="param" + description="Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` Please see {@see \Google\Cloud\Vision\V1\ProductSearchClient::productSetName()} for help formatting this field." + variable="name" type="string"/> - + name="param" + description="Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` Please see {@see \Google\Cloud\Vision\V1\ProductSearchClient::productName()} for help formatting this field." + variable="product" type="string"/> + name="return" + description="" + type="\Google\Cloud\Vision\V1\AddProductToProductSetRequest"/> - - - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - \Google\Cloud\Vision\Annotation\AbstractFeature - - - + /> - + - - + __construct - \Google\Cloud\Vision\Annotation\CropHint::__construct() + \Google\Cloud\Vision\V1\AddProductToProductSetRequest::__construct() - - info - + + data + null array - - + + Constructor. + description="{ Optional. Data for populating the Message object. @type string $name Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` @type string $product Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` }" + variable="data" type="array"/> - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + getName + \Google\Cloud\Vision\V1\AddProductToProductSetRequest::getName() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + Required. The resource name for the ProductSet to modify. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - + type="string"/> + - - boundingPoly - \Google\Cloud\Vision\Annotation\CropHint::boundingPoly() + + setName + \Google\Cloud\Vision\V1\AddProductToProductSetRequest::setName() - - - { -The bounding polygon of the recommended crop. + + var + + string + + + + Required. The resource name for the ProductSet to modify. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + - + type="$this"/> + - - confidence - \Google\Cloud\Vision\Annotation\CropHint::confidence() + + getProduct + \Google\Cloud\Vision\V1\AddProductToProductSetRequest::getProduct() - - - { -Confidence of this being a salient region. Range [0, 1]. + + Required. The resource name for the Product to be added to this ProductSet. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + +Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - + type="string"/> + - - importanceFraction - \Google\Cloud\Vision\Annotation\CropHint::importanceFraction() + + setProduct + \Google\Cloud\Vision\V1\AddProductToProductSetRequest::setProduct() - - - { -Fraction of importance of this salient region with respect to the -original image. + + var + + string + + + + Required. The resource name for the Product to be added to this ProductSet. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + +Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + - + type="$this"/> + - + - + - Copyright 2016 Google Inc. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - Document - \Google\Cloud\Vision\Annotation\Document - - Represents a Document Text Detection result. - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/the-constitution.jpg', 'r'); -$image = $vision->image($imageResource, [ 'DOCUMENT_TEXT_DETECTION' ]); -$annotation = $vision->annotate($image); - -$document = $annotation->fullText(); -``` + + + AnnotateFileRequest + \Google\Cloud\Vision\V1\AnnotateFileRequest + + A request to annotate one single file, e.g. a PDF, TIFF or GIF file. + Generated from protobuf message <code>google.cloud.vision.v1.AnnotateFileRequest</code> - - - - - - \Google\Cloud\Vision\Annotation\AbstractFeature + \Google\Protobuf\Internal\Message - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - + + input_config + \Google\Cloud\Vision\V1\AnnotateFileRequest::$input_config + null + + Required. Information about the input file. + Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + - - + + features + \Google\Cloud\Vision\V1\AnnotateFileRequest::$features + + + Required. Requested features. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + + + + + + image_context + \Google\Cloud\Vision\V1\AnnotateFileRequest::$image_context + null + + Additional context that may accompany the image(s) in the file. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + + + + + pages + \Google\Cloud\Vision\V1\AnnotateFileRequest::$pages + + + Pages of the file to perform image annotation. + Pages starts from 1, we assume the first page of the file is page 1. +At most 5 pages are supported per request. Pages can be negative. +Page 1 means the first page. +Page 2 means the second page. +Page -1 means the last page. +Page -2 means the second to the last page. +If the file is GIF instead of PDF or TIFF, page refers to GIF frames. +If this field is empty, by default the service performs image annotation +for the first 5 pages of the file. + +Generated from protobuf field <code>repeated int32 pages = 4;</code> + + + + + + __construct - \Google\Cloud\Vision\Annotation\Document::__construct() + \Google\Cloud\Vision\V1\AnnotateFileRequest::__construct() - - info - + + data + null array - - + + Constructor. + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\InputConfig $input_config Required. Information about the input file. @type \Google\Cloud\Vision\V1\Feature[] $features Required. Requested features. @type \Google\Cloud\Vision\V1\ImageContext $image_context Additional context that may accompany the image(s) in the file. @type int[] $pages Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. }" + variable="data" type="array"/> - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + getInputConfig + \Google\Cloud\Vision\V1\AnnotateFileRequest::getInputConfig() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + Required. Information about the input file. + Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> - - + type="\Google\Cloud\Vision\V1\InputConfig|null"/> + - - pages - \Google\Cloud\Vision\Annotation\Document::pages() + + hasInputConfig + \Google\Cloud\Vision\V1\AnnotateFileRequest::hasInputConfig() - + - { -Get the document pages. - - + + - - text - \Google\Cloud\Vision\Annotation\Document::text() + + clearInputConfig + \Google\Cloud\Vision\V1\AnnotateFileRequest::clearInputConfig() - + - { -Get the document text. - - + + - - info - \Google\Cloud\Vision\Annotation\Document::info() + + setInputConfig + \Google\Cloud\Vision\V1\AnnotateFileRequest::setInputConfig() - - Get the raw annotation result - { -Get the Document Text detection result. - - - - - - - - - - - - - - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - - - - - - - - - - - - Entity - \Google\Cloud\Vision\Annotation\Entity - - Represents an entity annotation. Entities are created by several -[Google Cloud Vision](https://cloud.google.com/vision/docs/) features, namely -`LANDMARK_DETECTION`, `LOGO_DETECTION`, `LABEL_DETECTION` and `TEXT_DETECTION`. - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = $vision->image($imageResource, [ 'text' ]); -$annotation = $vision->annotate($image); + + var + + \Google\Cloud\Vision\V1\InputConfig + -$text = $annotation->text()[0]; -``` + + Required. Information about the input file. + Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> - - - - - - - - - - - + variable="var" type="\Google\Cloud\Vision\V1\InputConfig"/> - - + type="$this"/> - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - \Google\Cloud\Vision\Annotation\AbstractFeature - - + + + + getFeatures + \Google\Cloud\Vision\V1\AnnotateFileRequest::getFeatures() + + + Required. Requested features. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Feature>"/> - + - - - __construct - \Google\Cloud\Vision\Annotation\Entity::__construct() + + setFeatures + \Google\Cloud\Vision\V1\AnnotateFileRequest::setFeatures() - - info + + var - array + \Google\Cloud\Vision\V1\Feature[] - - Create an entity annotation result. - This class is created internally by {@see \Google\Cloud\Vision\Annotation\Annotation} and is used to represent various -annotation feature results. - -This class should not be instantiated externally. - -Entities are returned by {@see \Google\Cloud\Vision\Annotation\Annotation::landmarks()}, -{@see \Google\Cloud\Vision\Annotation\Annotation::logos()}, -{@see \Google\Cloud\Vision\Annotation\Annotation::labels()} and -{@see \Google\Cloud\Vision\Annotation\Annotation::text()}. + + Required. Requested features. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\Feature[]"/> + - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + getImageContext + \Google\Cloud\Vision\V1\AnnotateFileRequest::getImageContext() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + Additional context that may accompany the image(s) in the file. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> - - + type="\Google\Cloud\Vision\V1\ImageContext|null"/> + - - mid - \Google\Cloud\Vision\Annotation\Entity::mid() + + hasImageContext + \Google\Cloud\Vision\V1\AnnotateFileRequest::hasImageContext() - + - { -Opaque entity ID. - - + + - - locale - \Google\Cloud\Vision\Annotation\Entity::locale() + + clearImageContext + \Google\Cloud\Vision\V1\AnnotateFileRequest::clearImageContext() - + - { -The language code for the locale in which the entity textual description -(next field) is expressed. - - + + - - description - \Google\Cloud\Vision\Annotation\Entity::description() + + setImageContext + \Google\Cloud\Vision\V1\AnnotateFileRequest::setImageContext() - - - { -Entity textual description, expressed in its locale language. - - - - + + var + + \Google\Cloud\Vision\V1\ImageContext + - - score - \Google\Cloud\Vision\Annotation\Entity::score() - - - - { -Overall score of the result. + + Additional context that may accompany the image(s) in the file. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> - - - - - - confidence - \Google\Cloud\Vision\Annotation\Entity::confidence() - - - - { -The accuracy of the entity detection in an image. - + - + type="$this"/> + - - topicality - \Google\Cloud\Vision\Annotation\Entity::topicality() + + getPages + \Google\Cloud\Vision\V1\AnnotateFileRequest::getPages() - - - { -The relevancy of the ICA (Image Content Annotation) label to the image. - - - - + + Pages of the file to perform image annotation. + Pages starts from 1, we assume the first page of the file is page 1. +At most 5 pages are supported per request. Pages can be negative. +Page 1 means the first page. +Page 2 means the second page. +Page -1 means the last page. +Page -2 means the second to the last page. +If the file is GIF instead of PDF or TIFF, page refers to GIF frames. +If this field is empty, by default the service performs image annotation +for the first 5 pages of the file. - - boundingPoly - \Google\Cloud\Vision\Annotation\Entity::boundingPoly() - - - - { -Image region to which this entity belongs. +Generated from protobuf field <code>repeated int32 pages = 4;</code> - + type="\Google\Protobuf\RepeatedField<int>"/> + - - locations - \Google\Cloud\Vision\Annotation\Entity::locations() + + setPages + \Google\Cloud\Vision\V1\AnnotateFileRequest::setPages() - - - { -The location information for the detected entity. - - + + var + + int[] + - + + Pages of the file to perform image annotation. + Pages starts from 1, we assume the first page of the file is page 1. +At most 5 pages are supported per request. Pages can be negative. +Page 1 means the first page. +Page 2 means the second page. +Page -1 means the last page. +Page -2 means the second to the last page. +If the file is GIF instead of PDF or TIFF, page refers to GIF frames. +If this field is empty, by default the service performs image annotation +for the first 5 pages of the file. - - properties - \Google\Cloud\Vision\Annotation\Entity::properties() - - - - { -Some entities can have additional optional Property fields. For example a -different kind of score or string that qualifies the entity. +Generated from protobuf field <code>repeated int32 pages = 4;</code> - - - - - - info - \Google\Cloud\Vision\Annotation\Entity::info() - - - Get the raw annotation result - { -Get the raw annotation result - + - + type="$this"/> + - + - + - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - Landmarks - \Google\Cloud\Vision\Annotation\Face\Landmarks - - Describes landmarks on a face (eyes, nose, chin, etc). - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = $vision->image($imageResource, ['FACE_DETECTION']); -$annotation = $vision->annotate($image); - -$faces = $annotation->faces(); -$firstFace = $faces[0]; - -$landmarks = $firstFace->landmarks(); -``` + + + AnnotateFileResponse + \Google\Cloud\Vision\V1\AnnotateFileResponse + + Response to a single file annotation request. A file may contain one or more +images, which individually have their own responses. + Generated from protobuf message <code>google.cloud.vision.v1.AnnotateFileResponse</code> - - - - \Google\Cloud\Vision\Annotation\AbstractFeature + \Google\Protobuf\Internal\Message - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info + + input_config + \Google\Cloud\Vision\V1\AnnotateFileResponse::$input_config + null + + Information about the file for which this response is generated. + Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + + + + + + responses + \Google\Cloud\Vision\V1\AnnotateFileResponse::$responses - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - + + Individual responses to images found within the file. This field will be +empty if the `error` field is set. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;</code> + - - + + total_pages + \Google\Cloud\Vision\V1\AnnotateFileResponse::$total_pages + 0 + + This field gives the total number of pages in the file. + Generated from protobuf field <code>int32 total_pages = 3;</code> + + + + + + error + \Google\Cloud\Vision\V1\AnnotateFileResponse::$error + null + + If set, represents the error message for the failed request. The +`responses` field will not be set in this case. + Generated from protobuf field <code>.google.rpc.Status error = 4;</code> + + + + + + __construct - \Google\Cloud\Vision\Annotation\Face\Landmarks::__construct() + \Google\Cloud\Vision\V1\AnnotateFileResponse::__construct() - - info - + + data + null array - - Create a landmarks results object. - This class should not be instantiated directly. It is created internally -by the Cloud Vision service wrapper to represent FACE_DETECTION annotation -results and provide helpful convenience to users. + + Constructor. + + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\InputConfig $input_config Information about the file for which this response is generated. @type \Google\Cloud\Vision\V1\AnnotateImageResponse[] $responses Individual responses to images found within the file. This field will be empty if the `error` field is set. @type int $total_pages This field gives the total number of pages in the file. @type \Google\Rpc\Status $error If set, represents the error message for the failed request. The `responses` field will not be set in this case. }" + variable="data" type="array"/> - - leftEye - \Google\Cloud\Vision\Annotation\Face\Landmarks::leftEye() + + getInputConfig + \Google\Cloud\Vision\V1\AnnotateFileResponse::getInputConfig() - - Fetch the left eye position. - Example: -``` -$pos = $landmarks->leftEye(); -echo "x position: ". $pos['x'] . PHP_EOL; -echo "y position: ". $pos['y'] . PHP_EOL; -echo "z position: ". $pos['z'] . PHP_EOL; -``` + + Information about the file for which this response is generated. + Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> - + type="\Google\Cloud\Vision\V1\InputConfig|null"/> - - leftEyePupil - \Google\Cloud\Vision\Annotation\Face\Landmarks::leftEyePupil() + + hasInputConfig + \Google\Cloud\Vision\V1\AnnotateFileResponse::hasInputConfig() - - Fetch the left eye pupil position. - Example: -``` -$pos = $landmarks->leftEyePupil(); -echo "x position: ". $pos['x'] . PHP_EOL; -echo "y position: ". $pos['y'] . PHP_EOL; -echo "z position: ". $pos['z'] . PHP_EOL; -``` - - - + + + + - - leftEyeBoundaries - \Google\Cloud\Vision\Annotation\Face\Landmarks::leftEyeBoundaries() + + clearInputConfig + \Google\Cloud\Vision\V1\AnnotateFileResponse::clearInputConfig() - - Fetch the left eye boundaries. - This method returns an array with four keys: `left`, `right`, `top`, `bottom`. -The value of each of these keys is of the normal Position format described -in the Cloud Vision documentation. - -Example: -``` -$positions = $landmarks->leftEyeBoundaries(); -foreach ($positions as $name => $pos) { - echo "Position Type: ". $name . PHP_EOL; - echo "x position: ". $pos['x'] . PHP_EOL; - echo "y position: ". $pos['y'] . PHP_EOL; - echo "z position: ". $pos['z'] . PHP_EOL; -} -``` - - - + + + + - - leftEyebrow - \Google\Cloud\Vision\Annotation\Face\Landmarks::leftEyebrow() + + setInputConfig + \Google\Cloud\Vision\V1\AnnotateFileResponse::setInputConfig() - - Fetch the left eyebrow position. - This method returns an array with three keys: `left`, `right`, `upperMidpoint`. -The value of each of these keys is of the normal Position format described -in the Cloud Vision documentation. + + var + + \Google\Cloud\Vision\V1\InputConfig + -Example: -``` -$positions = $landmarks->leftEyebrow(); -foreach ($positions as $name => $pos) { - echo "Position Type: ". $name . PHP_EOL; - echo "x position: ". $pos['x'] . PHP_EOL; - echo "y position: ". $pos['y'] . PHP_EOL; - echo "z position: ". $pos['z'] . PHP_EOL; -} -``` - - - - - - - - rightEye - \Google\Cloud\Vision\Annotation\Face\Landmarks::rightEye() - - - Fetch the right eye position. - Example: -``` -$pos = $landmarks->rightEye(); -echo "x position: ". $pos['x'] . PHP_EOL; -echo "y position: ". $pos['y'] . PHP_EOL; -echo "z position: ". $pos['z'] . PHP_EOL; -``` + + Information about the file for which this response is generated. + Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> - - - - - - - rightEyePupil - \Google\Cloud\Vision\Annotation\Face\Landmarks::rightEyePupil() - - - Fetch the right eye pupil position. - Example: -``` -$pos = $landmarks->rightEyePupil(); -echo "x position: ". $pos['x'] . PHP_EOL; -echo "y position: ". $pos['y'] . PHP_EOL; -echo "z position: ". $pos['z'] . PHP_EOL; -``` - + variable="var" type="\Google\Cloud\Vision\V1\InputConfig"/> + type="$this"/> - - rightEyeBoundaries - \Google\Cloud\Vision\Annotation\Face\Landmarks::rightEyeBoundaries() + + getResponses + \Google\Cloud\Vision\V1\AnnotateFileResponse::getResponses() - - Fetch the right eye boundaries. - This method returns an array with four keys: `left`, `right`, `top`, `bottom`. -The value of each of these keys is of the normal Position format described -in the Cloud Vision documentation. - -Example: -``` -$positions = $landmarks->rightEyeBoundaries(); -foreach ($positions as $name => $pos) { - echo "Position Type: ". $name . PHP_EOL; - echo "x position: ". $pos['x'] . PHP_EOL; - echo "y position: ". $pos['y'] . PHP_EOL; - echo "z position: ". $pos['z'] . PHP_EOL; -} -``` + + Individual responses to images found within the file. This field will be +empty if the `error` field is set. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;</code> - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\AnnotateImageResponse>"/> - - rightEyebrow - \Google\Cloud\Vision\Annotation\Face\Landmarks::rightEyebrow() + + setResponses + \Google\Cloud\Vision\V1\AnnotateFileResponse::setResponses() - - Fetch the right eyebrow position. - This method returns an array with three keys: `left`, `right`, `upperMidpoint`. -The value of each of these keys is of the normal Position format described -in the Cloud Vision documentation. + + var + + \Google\Cloud\Vision\V1\AnnotateImageResponse[] + -Example: -``` -$positions = $landmarks->rightEyebrow(); -foreach ($positions as $name => $pos) { - echo "Position Type: ". $name . PHP_EOL; - echo "x position: ". $pos['x'] . PHP_EOL; - echo "y position: ". $pos['y'] . PHP_EOL; - echo "z position: ". $pos['z'] . PHP_EOL; -} -``` + + Individual responses to images found within the file. This field will be +empty if the `error` field is set. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;</code> - - - - - - - midpointBetweenEyes - \Google\Cloud\Vision\Annotation\Face\Landmarks::midpointBetweenEyes() - - - Get the position of the midpoint beteeen the eyes. - Example: -``` -$pos = $landmarks->midpointBetweenEyes(); -echo "x position: ". $pos['x'] . PHP_EOL; -echo "y position: ". $pos['y'] . PHP_EOL; -echo "z position: ". $pos['z'] . PHP_EOL; -``` - + variable="var" type="\Google\Cloud\Vision\V1\AnnotateImageResponse[]"/> + type="$this"/> - - lips - \Google\Cloud\Vision\Annotation\Face\Landmarks::lips() + + getTotalPages + \Google\Cloud\Vision\V1\AnnotateFileResponse::getTotalPages() - - Get the position of the lips. - This method returns an array with two keys: `upper` and `lower`. -The value of each of these keys is of the normal Position format described -in the Cloud Vision documentation. - -Example: -``` -$positions = $landmarks->lips(); -foreach ($positions as $name => $pos) { - echo "Position Type: ". $name . PHP_EOL; - echo "x position: ". $pos['x'] . PHP_EOL; - echo "y position: ". $pos['y'] . PHP_EOL; - echo "z position: ". $pos['z'] . PHP_EOL; -} -``` + + This field gives the total number of pages in the file. + Generated from protobuf field <code>int32 total_pages = 3;</code> - + type="int"/> - - mouth - \Google\Cloud\Vision\Annotation\Face\Landmarks::mouth() + + setTotalPages + \Google\Cloud\Vision\V1\AnnotateFileResponse::setTotalPages() - - Get the position of the mouth. - This method returns an array with three keys: `left`, `right`, `center`. -The value of each of these keys is of the normal Position format described -in the Cloud Vision documentation. + + var + + int + -Example: -``` -$positions = $landmarks->mouth(); -foreach ($positions as $name => $pos) { - echo "Position Type: ". $name . PHP_EOL; - echo "x position: ". $pos['x'] . PHP_EOL; - echo "y position: ". $pos['y'] . PHP_EOL; - echo "z position: ". $pos['z'] . PHP_EOL; -} -``` + + This field gives the total number of pages in the file. + Generated from protobuf field <code>int32 total_pages = 3;</code> - - - - - - - nose - \Google\Cloud\Vision\Annotation\Face\Landmarks::nose() - - - Get the position of the nose. - This method returns an array with four keys: `tip`, `bottomRight`, `bottomLeft`, `bottomCenter`. -The value of each of these keys is of the normal Position format described -in the Cloud Vision documentation. - -Example: -``` -$positions = $landmarks->nose(); -foreach ($positions as $name => $pos) { - echo "Position Type: ". $name . PHP_EOL; - echo "x position: ". $pos['x'] . PHP_EOL; - echo "y position: ". $pos['y'] . PHP_EOL; - echo "z position: ". $pos['z'] . PHP_EOL; -} -``` - + variable="var" type="int"/> + type="$this"/> - - ears - \Google\Cloud\Vision\Annotation\Face\Landmarks::ears() + + getError + \Google\Cloud\Vision\V1\AnnotateFileResponse::getError() - - Get the position of the ears. - This method returns an array with two keys: `left` and `right`. -The value of each of these keys is of the normal Position format described -in the Cloud Vision documentation. - -Example: -``` -$positions = $landmarks->ears(); -foreach ($positions as $name => $pos) { - echo "Position Type: ". $name . PHP_EOL; - echo "x position: ". $pos['x'] . PHP_EOL; - echo "y position: ". $pos['y'] . PHP_EOL; - echo "z position: ". $pos['z'] . PHP_EOL; -} -``` + + If set, represents the error message for the failed request. The +`responses` field will not be set in this case. + Generated from protobuf field <code>.google.rpc.Status error = 4;</code> - - + type="\Google\Rpc\Status|null"/> - - forehead - \Google\Cloud\Vision\Annotation\Face\Landmarks::forehead() + + hasError + \Google\Cloud\Vision\V1\AnnotateFileResponse::hasError() - - Get the position of the forehead glabella. - Example: -``` -$pos = $landmarks->forehead(); -echo "x position: ". $pos['x'] . PHP_EOL; -echo "y position: ". $pos['y'] . PHP_EOL; -echo "z position: ". $pos['z'] . PHP_EOL; -``` - - - + + + + - - chin - \Google\Cloud\Vision\Annotation\Face\Landmarks::chin() + + clearError + \Google\Cloud\Vision\V1\AnnotateFileResponse::clearError() - - Get the position of the chin. - This method returns an array with three keys: `left`, `right`, `gnathion`. -The value of each of these keys is of the normal Position format described -in the Cloud Vision documentation. - -Example: -``` -$positions = $landmarks->chin(); -foreach ($positions as $name => $pos) { - echo "Position Type: ". $name . PHP_EOL; - echo "x position: ". $pos['x'] . PHP_EOL; - echo "y position: ". $pos['y'] . PHP_EOL; - echo "z position: ". $pos['z'] . PHP_EOL; -} -``` - - - + + + + - - getLandmark - \Google\Cloud\Vision\Annotation\Face\Landmarks::getLandmark() + + setError + \Google\Cloud\Vision\V1\AnnotateFileResponse::setError() - - type + + var - mixed + \Google\Rpc\Status - - - - - - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() - - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + If set, represents the error message for the failed request. The +`responses` field will not be set in this case. + Generated from protobuf field <code>.google.rpc.Status error = 4;</code> + variable="var" type="\Google\Rpc\Status"/> - - - - - - info - \Google\Cloud\Vision\Annotation\Face\Landmarks::info() - - - Get the raw annotation result - { -Get the raw landmarks annotation result - - + type="$this"/> + - + - should this be earTragions? - + - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - Face - \Google\Cloud\Vision\Annotation\Face - - Represents a face annotation result - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = $vision->image($imageResource, [ 'FACE_DETECTION' ]); -$annotation = $vision->annotate($image); - -$faces = $annotation->faces(); -$face = $faces[0]; -``` + + + AnnotateImageRequest + \Google\Cloud\Vision\V1\AnnotateImageRequest + + Request for performing Google Cloud Vision API tasks over a user-provided +image, with user-requested features, and with context information. + Generated from protobuf message <code>google.cloud.vision.v1.AnnotateImageRequest</code> - - - - - - - - - - - - - - - - - - - - \Google\Cloud\Vision\Annotation\AbstractFeature + \Google\Protobuf\Internal\Message - - landmarks - \Google\Cloud\Vision\Annotation\Face::$landmarks - - - - - - + + image + \Google\Cloud\Vision\V1\AnnotateImageRequest::$image + null + + The image to be processed. + Generated from protobuf field <code>.google.cloud.vision.v1.Image image = 1;</code> + - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info + + features + \Google\Cloud\Vision\V1\AnnotateImageRequest::$features - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - + + Requested features. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + - - likelihoodLevels - \Google\Cloud\Vision\Annotation\LikelihoodTrait::$likelihoodLevels - [\Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_HIGH => ['VERY_LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_MEDIUM => ['VERY_LIKELY', 'LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_LOW => ['VERY_LIKELY', 'LIKELY', 'POSSIBLE']] - \Google\Cloud\Vision\Annotation\LikelihoodTrait - - - - + + image_context + \Google\Cloud\Vision\V1\AnnotateImageRequest::$image_context + null + + Additional context that may accompany the image. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + - - + + __construct - \Google\Cloud\Vision\Annotation\Face::__construct() + \Google\Cloud\Vision\V1\AnnotateImageRequest::__construct() - - info - + + data + null array - - Create an Face result. - This class is created internally by {@see \Google\Cloud\Vision\Annotation\Annotation}. -See {@see \Google\Cloud\Vision\Annotation\Annotation::faces()} for full usage details. -This class should not be instantiated outside the externally. + + Constructor. + + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\Image $image The image to be processed. @type \Google\Cloud\Vision\V1\Feature[] $features Requested features. @type \Google\Cloud\Vision\V1\ImageContext $image_context Additional context that may accompany the image. }" + variable="data" type="array"/> - - landmarks - \Google\Cloud\Vision\Annotation\Face::landmarks() + + getImage + \Google\Cloud\Vision\V1\AnnotateImageRequest::getImage() - - Returns an object detailing facial landmarks and their location. - Example: -``` -$leftEye = $face->landmarks()->leftEye(); -``` + + The image to be processed. + Generated from protobuf field <code>.google.cloud.vision.v1.Image image = 1;</code> - + type="\Google\Cloud\Vision\V1\Image|null"/> + - - isJoyful - \Google\Cloud\Vision\Annotation\Face::isJoyful() + + hasImage + \Google\Cloud\Vision\V1\AnnotateImageRequest::hasImage() - - strength - self::STRENGTH_LOW - string - - - - Check whether the face is joyful. - Example: -``` -if ($face->isJoyful()) { - echo "Face is Joyful"; -} -``` - - - + + + + - - isSorrowful - \Google\Cloud\Vision\Annotation\Face::isSorrowful() + + clearImage + \Google\Cloud\Vision\V1\AnnotateImageRequest::clearImage() - - strength - self::STRENGTH_LOW - string - - - - Check whether the face is sorrowful. - Example: -``` -if ($face->isSorrowful()) { - echo "Face is Sorrowful"; -} -``` - - - + + + + - - isAngry - \Google\Cloud\Vision\Annotation\Face::isAngry() + + setImage + \Google\Cloud\Vision\V1\AnnotateImageRequest::setImage() - - strength - self::STRENGTH_LOW - string + + var + + \Google\Cloud\Vision\V1\Image - - Check whether the face is angry. - Example: -``` -if ($face->isAngry()) { - echo "Face is Angry"; -} -``` + + The image to be processed. + Generated from protobuf field <code>.google.cloud.vision.v1.Image image = 1;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\Image"/> + type="$this"/> - - isSurprised - \Google\Cloud\Vision\Annotation\Face::isSurprised() + + getFeatures + \Google\Cloud\Vision\V1\AnnotateImageRequest::getFeatures() - - strength - self::STRENGTH_LOW - string - - - - Check whether the face is surprised. - Example: -``` -if ($face->isSurprised()) { - echo "Face is Surprised"; -} -``` + + Requested features. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Feature>"/> - - isUnderExposed - \Google\Cloud\Vision\Annotation\Face::isUnderExposed() + + setFeatures + \Google\Cloud\Vision\V1\AnnotateImageRequest::setFeatures() - - strength - self::STRENGTH_LOW - string + + var + + \Google\Cloud\Vision\V1\Feature[] - - Check whether the face is under exposed. - Example: -``` -if ($face->isUnderExposed()) { - echo "Face is Under Exposed"; -} -``` + + Requested features. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\Feature[]"/> + type="$this"/> - - isBlurred - \Google\Cloud\Vision\Annotation\Face::isBlurred() + + getImageContext + \Google\Cloud\Vision\V1\AnnotateImageRequest::getImageContext() - - strength - self::STRENGTH_LOW - string - - - - Check whether the face is blurred. - Example: -``` -if ($face->isBlurred()) { - echo "Face is Blurred"; -} -``` + + Additional context that may accompany the image. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> - + type="\Google\Cloud\Vision\V1\ImageContext|null"/> - - hasHeadwear - \Google\Cloud\Vision\Annotation\Face::hasHeadwear() + + hasImageContext + \Google\Cloud\Vision\V1\AnnotateImageRequest::hasImageContext() - - strength - self::STRENGTH_LOW - string - - - - Check whether the person is wearing headwear. - Example: -``` -if ($face->hasHeadwear()) { - echo "Face has Headwear"; -} -``` - - - + + + + - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + clearImageContext + \Google\Cloud\Vision\V1\AnnotateImageRequest::clearImageContext() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` - - - + + + + - - likelihood - \Google\Cloud\Vision\Annotation\LikelihoodTrait::likelihood() + + setImageContext + \Google\Cloud\Vision\V1\AnnotateImageRequest::setImageContext() - \Google\Cloud\Vision\Annotation\LikelihoodTrait - value - - string - - - - strength + + var - string + \Google\Cloud\Vision\V1\ImageContext - - - + + Additional context that may accompany the image. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> - + description="" + variable="var" type="\Google\Cloud\Vision\V1\ImageContext"/> + type="$this"/> - - boundingPoly - \Google\Cloud\Vision\Annotation\Face::boundingPoly() - + + + + + + + - { -The bounding polygon around the face. + + name="package" + description="Application" + /> - - - - fdBoundingPoly - \Google\Cloud\Vision\Annotation\Face::fdBoundingPoly() - - - - { -Bounding polygon around the face. - - - + + + - - rollAngle - \Google\Cloud\Vision\Annotation\Face::rollAngle() - - - - { -Roll angle. + + + + + + AnnotateImageResponse + \Google\Cloud\Vision\V1\AnnotateImageResponse + + Response to an image annotation request. + Generated from protobuf message <code>google.cloud.vision.v1.AnnotateImageResponse</code> - - - + name="package" + description="Application" + /> + - - panAngle - \Google\Cloud\Vision\Annotation\Face::panAngle() - - - - { -Yaw angle. - - + \Google\Protobuf\Internal\Message + + + + face_annotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::$face_annotations + + + If present, face detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation face_annotations = 1;</code> + - + - - tiltAngle - \Google\Cloud\Vision\Annotation\Face::tiltAngle() - - - - { -Pitch angle. - - + + landmark_annotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::$landmark_annotations + + + If present, landmark detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation landmark_annotations = 2;</code> + - + - - detectionConfidence - \Google\Cloud\Vision\Annotation\Face::detectionConfidence() - - - - { -The detection confidence. - - + + logo_annotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::$logo_annotations + + + If present, logo detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation logo_annotations = 3;</code> + - + - - landmarkingConfidence - \Google\Cloud\Vision\Annotation\Face::landmarkingConfidence() + + label_annotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::$label_annotations + + + If present, label detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation label_annotations = 4;</code> + + + + + + localized_object_annotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::$localized_object_annotations + + + If present, localized object detection has completed successfully. + This will be sorted descending by confidence score. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocalizedObjectAnnotation localized_object_annotations = 22;</code> + + + + + + text_annotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::$text_annotations + + + If present, text (OCR) detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation text_annotations = 5;</code> + + + + + + full_text_annotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::$full_text_annotation + null + + If present, text (OCR) detection or document (OCR) text detection has +completed successfully. + This annotation provides the structural hierarchy for the OCR detected +text. + +Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation full_text_annotation = 12;</code> + + + + + + safe_search_annotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::$safe_search_annotation + null + + If present, safe-search annotation has completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.SafeSearchAnnotation safe_search_annotation = 6;</code> + + + + + + image_properties_annotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::$image_properties_annotation + null + + If present, image properties were extracted successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageProperties image_properties_annotation = 8;</code> + + + + + + crop_hints_annotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::$crop_hints_annotation + null + + If present, crop hints have completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsAnnotation crop_hints_annotation = 11;</code> + + + + + + web_detection + \Google\Cloud\Vision\V1\AnnotateImageResponse::$web_detection + null + + If present, web detection has completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.WebDetection web_detection = 13;</code> + + + + + + product_search_results + \Google\Cloud\Vision\V1\AnnotateImageResponse::$product_search_results + null + + If present, product search has completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchResults product_search_results = 14;</code> + + + + + + error + \Google\Cloud\Vision\V1\AnnotateImageResponse::$error + null + + If set, represents the error message for the operation. + Note that filled-in image annotations are guaranteed to be +correct, even when `error` is set. + +Generated from protobuf field <code>.google.rpc.Status error = 9;</code> + + + + + + context + \Google\Cloud\Vision\V1\AnnotateImageResponse::$context + null + + If present, contextual information is needed to understand where this image +comes from. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageAnnotationContext context = 21;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\AnnotateImageResponse::__construct() - - - { -Face landmarking confidence. + + data + null + array + + + + Constructor. + - + name="param" + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\FaceAnnotation[] $face_annotations If present, face detection has completed successfully. @type \Google\Cloud\Vision\V1\EntityAnnotation[] $landmark_annotations If present, landmark detection has completed successfully. @type \Google\Cloud\Vision\V1\EntityAnnotation[] $logo_annotations If present, logo detection has completed successfully. @type \Google\Cloud\Vision\V1\EntityAnnotation[] $label_annotations If present, label detection has completed successfully. @type \Google\Cloud\Vision\V1\LocalizedObjectAnnotation[] $localized_object_annotations If present, localized object detection has completed successfully. This will be sorted descending by confidence score. @type \Google\Cloud\Vision\V1\EntityAnnotation[] $text_annotations If present, text (OCR) detection has completed successfully. @type \Google\Cloud\Vision\V1\TextAnnotation $full_text_annotation If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. @type \Google\Cloud\Vision\V1\SafeSearchAnnotation $safe_search_annotation If present, safe-search annotation has completed successfully. @type \Google\Cloud\Vision\V1\ImageProperties $image_properties_annotation If present, image properties were extracted successfully. @type \Google\Cloud\Vision\V1\CropHintsAnnotation $crop_hints_annotation If present, crop hints have completed successfully. @type \Google\Cloud\Vision\V1\WebDetection $web_detection If present, web detection has completed successfully. @type \Google\Cloud\Vision\V1\ProductSearchResults $product_search_results If present, product search has completed successfully. @type \Google\Rpc\Status $error If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. @type \Google\Cloud\Vision\V1\ImageAnnotationContext $context If present, contextual information is needed to understand where this image comes from. }" + variable="data" type="array"/> + - - joyLikelihood - \Google\Cloud\Vision\Annotation\Face::joyLikelihood() + + getFaceAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::getFaceAnnotations() - - - { -Joy likelihood. + + If present, face detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation face_annotations = 1;</code> - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\FaceAnnotation>"/> + - - sorrowLikelihood - \Google\Cloud\Vision\Annotation\Face::sorrowLikelihood() + + setFaceAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::setFaceAnnotations() - - - { -Sorrow likelihood. + + var + + \Google\Cloud\Vision\V1\FaceAnnotation[] + + + + If present, face detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation face_annotations = 1;</code> + - + type="$this"/> + - - angerLikelihood - \Google\Cloud\Vision\Annotation\Face::angerLikelihood() + + getLandmarkAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::getLandmarkAnnotations() - - - { -Anger likelihood. + + If present, landmark detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation landmark_annotations = 2;</code> - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\EntityAnnotation>"/> + - - surpriseLikelihood - \Google\Cloud\Vision\Annotation\Face::surpriseLikelihood() + + setLandmarkAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::setLandmarkAnnotations() - - - { -Surprise likelihood. + + var + + \Google\Cloud\Vision\V1\EntityAnnotation[] + + + + If present, landmark detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation landmark_annotations = 2;</code> + - + type="$this"/> + - - underExposedLikelihood - \Google\Cloud\Vision\Annotation\Face::underExposedLikelihood() + + getLogoAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::getLogoAnnotations() - - - { -Under exposure likelihood. + + If present, logo detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation logo_annotations = 3;</code> - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\EntityAnnotation>"/> + - - blurredLikelihood - \Google\Cloud\Vision\Annotation\Face::blurredLikelihood() + + setLogoAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::setLogoAnnotations() - - - { -Blurred likelihood. + + var + + \Google\Cloud\Vision\V1\EntityAnnotation[] + + + + If present, logo detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation logo_annotations = 3;</code> + - + type="$this"/> + - - headwearLikelihood - \Google\Cloud\Vision\Annotation\Face::headwearLikelihood() + + getLabelAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::getLabelAnnotations() - - - { -Headwear likelihood. + + If present, label detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation label_annotations = 4;</code> - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\EntityAnnotation>"/> + - - info - \Google\Cloud\Vision\Annotation\Face::info() + + setLabelAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::setLabelAnnotations() - - Get the raw annotation result - { -Get the raw annotation result + + var + + \Google\Cloud\Vision\V1\EntityAnnotation[] + + + + If present, label detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation label_annotations = 4;</code> + - + type="$this"/> + - - - - - - - - - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 + + getLocalizedObjectAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::getLocalizedObjectAnnotations() + + + If present, localized object detection has completed successfully. + This will be sorted descending by confidence score. -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. +Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocalizedObjectAnnotation localized_object_annotations = 22;</code> - + name="return" + description="" + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\LocalizedObjectAnnotation>"/> + + - - - + + setLocalizedObjectAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::setLocalizedObjectAnnotations() + + + var + + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation[] + - - - - FeatureInterface - \Google\Cloud\Vision\Annotation\FeatureInterface - - Define shared functionality for annotation features. - + + If present, localized object detection has completed successfully. + This will be sorted descending by confidence score. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocalizedObjectAnnotation localized_object_annotations = 22;</code> + name="param" + description="" + variable="var" type="\Google\Cloud\Vision\V1\LocalizedObjectAnnotation[]"/> - - - - STRENGTH_HIGH - \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_HIGH - 'high' - - - - - - - - - STRENGTH_MEDIUM - \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_MEDIUM - 'medium' - - - - - - - - - STRENGTH_LOW - \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_LOW - 'low' - - - - + name="return" + description="" + type="$this"/> + - + - - info - \Google\Cloud\Vision\Annotation\FeatureInterface::info() + + getTextAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::getTextAnnotations() - - - + + If present, text (OCR) detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation text_annotations = 5;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\EntityAnnotation>"/> - - - - - - - - - - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 + + setTextAnnotations + \Google\Cloud\Vision\V1\AnnotateImageResponse::setTextAnnotations() + + + var + + \Google\Cloud\Vision\V1\EntityAnnotation[] + -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + If present, text (OCR) detection has completed successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation text_annotations = 5;</code> - + name="param" + description="" + variable="var" type="\Google\Cloud\Vision\V1\EntityAnnotation[]"/> + + + - - - + + getFullTextAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::getFullTextAnnotation() + + + If present, text (OCR) detection or document (OCR) text detection has +completed successfully. + This annotation provides the structural hierarchy for the OCR detected +text. - - - - - ImageProperties - \Google\Cloud\Vision\Annotation\ImageProperties - - Represents the imageProperties feature result - Example: -``` -use Google\Cloud\Vision\VisionClient; +Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation full_text_annotation = 12;</code> + + -$vision = new VisionClient(); + -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = $vision->image($imageResource, [ 'imageProperties' ]); -$annotation = $vision->annotate($image); + + hasFullTextAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::hasFullTextAnnotation() + + + + + -$imageProperties = $annotation->imageProperties(); -``` - - - - - + - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - \Google\Cloud\Vision\Annotation\AbstractFeature + + clearFullTextAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::clearFullTextAnnotation() + + - - + - + - - - __construct - \Google\Cloud\Vision\Annotation\ImageProperties::__construct() + + setFullTextAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::setFullTextAnnotation() - - info + + var - array + \Google\Cloud\Vision\V1\TextAnnotation - - Create an ImageProperties result. - This class is created internally by {@see \Google\Cloud\Vision\Annotation\Annotation}. -See {@see \Google\Cloud\Vision\Annotation\Annotation::imageProperties()} for full usage details. -This class should not be instantiated outside the externally. - - - - + + If present, text (OCR) detection or document (OCR) text detection has +completed successfully. + This annotation provides the structural hierarchy for the OCR detected +text. - - colors - \Google\Cloud\Vision\Annotation\ImageProperties::colors() - - - Get the dominant colors in the image - Example: -``` -$colors = $imageProperties->colors(); -``` +Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation full_text_annotation = 12;</code> + name="param" + description="" + variable="var" type="\Google\Cloud\Vision\V1\TextAnnotation"/> + type="$this"/> - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + getSafeSearchAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::getSafeSearchAnnotation() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + If present, safe-search annotation has completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.SafeSearchAnnotation safe_search_annotation = 6;</code> - - + type="\Google\Cloud\Vision\V1\SafeSearchAnnotation|null"/> + - - info - \Google\Cloud\Vision\Annotation\ImageProperties::info() + + hasSafeSearchAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::hasSafeSearchAnnotation() - - Get the raw annotation result - { -Get the raw annotation result - - + + + + - - - - - - - - - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - - - - - - - - - - - - - LikelihoodTrait - \Google\Cloud\Vision\Annotation\LikelihoodTrait - - Provide likelihood functionality to annotation features. - - - - - - - likelihoodLevels - \Google\Cloud\Vision\Annotation\LikelihoodTrait::$likelihoodLevels - [\Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_HIGH => ['VERY_LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_MEDIUM => ['VERY_LIKELY', 'LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_LOW => ['VERY_LIKELY', 'LIKELY', 'POSSIBLE']] - + + clearSafeSearchAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::clearSafeSearchAnnotation() + + - - + - + - - - likelihood - \Google\Cloud\Vision\Annotation\LikelihoodTrait::likelihood() + + setSafeSearchAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::setSafeSearchAnnotation() - - value - - string - - - - strength + + var - string + \Google\Cloud\Vision\V1\SafeSearchAnnotation - - - + + If present, safe-search annotation has completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.SafeSearchAnnotation safe_search_annotation = 6;</code> - + description="" + variable="var" type="\Google\Cloud\Vision\V1\SafeSearchAnnotation"/> + type="$this"/> - - - - - - - - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - - - - - - - - - - - - SafeSearch - \Google\Cloud\Vision\Annotation\SafeSearch - - Represents a SafeSearch annotation result - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = $vision->image($imageResource, [ 'safeSearch' ]); -$annotation = $vision->annotate($image); - -$safeSearch = $annotation->safeSearch(); -``` - - - - - - - - - - - - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - \Google\Cloud\Vision\Annotation\AbstractFeature - - + + getImagePropertiesAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::getImagePropertiesAnnotation() + + + If present, image properties were extracted successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageProperties image_properties_annotation = 8;</code> + type="\Google\Cloud\Vision\V1\ImageProperties|null"/> - + - - likelihoodLevels - \Google\Cloud\Vision\Annotation\LikelihoodTrait::$likelihoodLevels - [\Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_HIGH => ['VERY_LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_MEDIUM => ['VERY_LIKELY', 'LIKELY'], \Google\Cloud\Vision\Annotation\FeatureInterface::STRENGTH_LOW => ['VERY_LIKELY', 'LIKELY', 'POSSIBLE']] - \Google\Cloud\Vision\Annotation\LikelihoodTrait + + hasImagePropertiesAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::hasImagePropertiesAnnotation() + + - - + - + - - - __construct - \Google\Cloud\Vision\Annotation\SafeSearch::__construct() + + clearImagePropertiesAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::clearImagePropertiesAnnotation() - - info - - array - - - - Create a SafeSearch annotation result - This class is instantiated internally and is used to represent the result of Cloud Vision's SafeSearch annotation -feature. It should not be instantiated directly. For complete usage instructions, please refer to -{@see \Google\Cloud\Vision\Annotation::safeSearch()}. - - + + + + - - isAdult - \Google\Cloud\Vision\Annotation\SafeSearch::isAdult() + + setImagePropertiesAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::setImagePropertiesAnnotation() - - strength - self::STRENGTH_LOW - string + + var + + \Google\Cloud\Vision\V1\ImageProperties - - Check whether the image contains adult content. - Example: -``` -if ($safeSearch->isAdult()) { - echo "Image contains adult content."; -} -``` + + If present, image properties were extracted successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageProperties image_properties_annotation = 8;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\ImageProperties"/> + type="$this"/> - - isSpoof - \Google\Cloud\Vision\Annotation\SafeSearch::isSpoof() + + getCropHintsAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::getCropHintsAnnotation() - - strength - self::STRENGTH_LOW - string - - - - Check whether the image was modified to make it appear funny or offensive. - Example: -``` -if ($safeSearch->isSpoof()) { - echo "Image contains spoofed content."; -} -``` + + If present, crop hints have completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsAnnotation crop_hints_annotation = 11;</code> - + type="\Google\Cloud\Vision\V1\CropHintsAnnotation|null"/> - - isMedical - \Google\Cloud\Vision\Annotation\SafeSearch::isMedical() + + hasCropHintsAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::hasCropHintsAnnotation() - - strength - self::STRENGTH_LOW - string - + + + + - - Check whether the image contains medical content - Example: -``` -if ($safeSearch->medical()) { - echo "Image contains medical content."; -} -``` - - - + + + + clearCropHintsAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::clearCropHintsAnnotation() + + + + + - - isViolent - \Google\Cloud\Vision\Annotation\SafeSearch::isViolent() + + setCropHintsAnnotation + \Google\Cloud\Vision\V1\AnnotateImageResponse::setCropHintsAnnotation() - - strength - self::STRENGTH_LOW - string + + var + + \Google\Cloud\Vision\V1\CropHintsAnnotation - - Check whether the image contains violent content - Example: -``` -if ($safeSearch->isViolent()) { - echo "Image contains violent content."; -} -``` + + If present, crop hints have completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsAnnotation crop_hints_annotation = 11;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\CropHintsAnnotation"/> + type="$this"/> - - isRacy - \Google\Cloud\Vision\Annotation\SafeSearch::isRacy() + + getWebDetection + \Google\Cloud\Vision\V1\AnnotateImageResponse::getWebDetection() - - strength - self::STRENGTH_LOW - string - + + If present, web detection has completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.WebDetection web_detection = 13;</code> + + + + + + + hasWebDetection + \Google\Cloud\Vision\V1\AnnotateImageResponse::hasWebDetection() + + + + + + + + + + clearWebDetection + \Google\Cloud\Vision\V1\AnnotateImageResponse::clearWebDetection() + + + + + + + - - Check whether the image contains racy content - Example: -``` -if ($safeSearch->isRacy()) { - echo "Image contains racy content."; -} -``` + + setWebDetection + \Google\Cloud\Vision\V1\AnnotateImageResponse::setWebDetection() + + + var + + \Google\Cloud\Vision\V1\WebDetection + + + + If present, web detection has completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.WebDetection web_detection = 13;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\WebDetection"/> + type="$this"/> - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + getProductSearchResults + \Google\Cloud\Vision\V1\AnnotateImageResponse::getProductSearchResults() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + If present, product search has completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchResults product_search_results = 14;</code> - - + type="\Google\Cloud\Vision\V1\ProductSearchResults|null"/> + + + + + + hasProductSearchResults + \Google\Cloud\Vision\V1\AnnotateImageResponse::hasProductSearchResults() + + + + + - - likelihood - \Google\Cloud\Vision\Annotation\LikelihoodTrait::likelihood() + + clearProductSearchResults + \Google\Cloud\Vision\V1\AnnotateImageResponse::clearProductSearchResults() - \Google\Cloud\Vision\Annotation\LikelihoodTrait - value - - string - + + + + + + - - strength + + setProductSearchResults + \Google\Cloud\Vision\V1\AnnotateImageResponse::setProductSearchResults() + + + var - string + \Google\Cloud\Vision\V1\ProductSearchResults - - - + + If present, product search has completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchResults product_search_results = 14;</code> - + description="" + variable="var" type="\Google\Cloud\Vision\V1\ProductSearchResults"/> + type="$this"/> - - adult - \Google\Cloud\Vision\Annotation\SafeSearch::adult() + + getError + \Google\Cloud\Vision\V1\AnnotateImageResponse::getError() - - - { -Represents the adult contents likelihood for the image. + + If set, represents the error message for the operation. + Note that filled-in image annotations are guaranteed to be +correct, even when `error` is set. + +Generated from protobuf field <code>.google.rpc.Status error = 9;</code> - + type="\Google\Rpc\Status|null"/> + - - spoof - \Google\Cloud\Vision\Annotation\SafeSearch::spoof() + + hasError + \Google\Cloud\Vision\V1\AnnotateImageResponse::hasError() - + - { -Spoof likelihood. The likelihood that an obvious modification was made to -the image's canonical version to make it appear funny or offensive. - - + + - - medical - \Google\Cloud\Vision\Annotation\SafeSearch::medical() + + clearError + \Google\Cloud\Vision\V1\AnnotateImageResponse::clearError() - + - { -Likelihood this is a medical image. + + + + + + + setError + \Google\Cloud\Vision\V1\AnnotateImageResponse::setError() + + + var + + \Google\Rpc\Status + + + + If set, represents the error message for the operation. + Note that filled-in image annotations are guaranteed to be +correct, even when `error` is set. + +Generated from protobuf field <code>.google.rpc.Status error = 9;</code> + - + type="$this"/> + - - violence - \Google\Cloud\Vision\Annotation\SafeSearch::violence() + + getContext + \Google\Cloud\Vision\V1\AnnotateImageResponse::getContext() - - - { -Violence likelihood. + + If present, contextual information is needed to understand where this image +comes from. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageAnnotationContext context = 21;</code> - + type="\Google\Cloud\Vision\V1\ImageAnnotationContext|null"/> + - - racy - \Google\Cloud\Vision\Annotation\SafeSearch::racy() + + hasContext + \Google\Cloud\Vision\V1\AnnotateImageResponse::hasContext() - + - { -Racy likelihood. - - + + - - info - \Google\Cloud\Vision\Annotation\SafeSearch::info() + + clearContext + \Google\Cloud\Vision\V1\AnnotateImageResponse::clearContext() - - Get the raw annotation result - { -Get the raw annotation result + + + + + + + + + setContext + \Google\Cloud\Vision\V1\AnnotateImageResponse::setContext() + + + var + + \Google\Cloud\Vision\V1\ImageAnnotationContext + + + + If present, contextual information is needed to understand where this image +comes from. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageAnnotationContext context = 21;</code> + - + type="$this"/> + - + - + - Copyright 2016 Google Inc. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - WebEntity - \Google\Cloud\Vision\Annotation\Web\WebEntity - - Represents an Entity deduced from similar images on the Internet. - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/eiffel-tower.jpg', 'r'); -$image = $vision->image($imageResource, ['WEB_DETECTION']); -$annotation = $vision->annotate($image); - -$entities = $annotation->web()->entities(); -$firstEntity = $entities[0]; -``` + + + AsyncAnnotateFileRequest + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest + + An offline file annotation request. + Generated from protobuf message <code>google.cloud.vision.v1.AsyncAnnotateFileRequest</code> - - - - - - \Google\Cloud\Vision\Annotation\AbstractFeature + \Google\Protobuf\Internal\Message - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info + + input_config + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::$input_config + null + + Required. Information about the input file. + Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + + + + + + features + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::$features - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - + + Required. Requested features. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + - - + + image_context + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::$image_context + null + + Additional context that may accompany the image(s) in the file. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + + + + + output_config + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::$output_config + null + + Required. The desired output location and metadata (e.g. format). + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 4;</code> + + + + + + __construct - \Google\Cloud\Vision\Annotation\Web\WebEntity::__construct() + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::__construct() - - info - + + data + null array - - + + Constructor. + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\InputConfig $input_config Required. Information about the input file. @type \Google\Cloud\Vision\V1\Feature[] $features Required. Requested features. @type \Google\Cloud\Vision\V1\ImageContext $image_context Additional context that may accompany the image(s) in the file. @type \Google\Cloud\Vision\V1\OutputConfig $output_config Required. The desired output location and metadata (e.g. format). }" + variable="data" type="array"/> - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + getInputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::getInputConfig() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + Required. Information about the input file. + Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> - - + type="\Google\Cloud\Vision\V1\InputConfig|null"/> + - - entityId - \Google\Cloud\Vision\Annotation\Web\WebEntity::entityId() + + hasInputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::hasInputConfig() - + - { -The Entity ID - - + + - - score - \Google\Cloud\Vision\Annotation\Web\WebEntity::score() + + clearInputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::clearInputConfig() - + - { -Overall relevancy score for the image. - - + + - - description - \Google\Cloud\Vision\Annotation\Web\WebEntity::description() + + setInputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::setInputConfig() - - - { -Canonical description of the entity, in English. + + var + + \Google\Cloud\Vision\V1\InputConfig + + + + Required. Information about the input file. + Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + - + type="$this"/> + - - - - - - - - - Copyright 2016 Google Inc. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - - - - - - - - - - - - WebImage - \Google\Cloud\Vision\Annotation\Web\WebImage - - Represents a Web Image from a Web Detection operation. - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/eiffel-tower.jpg', 'r'); -$image = $vision->image($imageResource, ['WEB_DETECTION']); -$annotation = $vision->annotate($image); - -$matchingImages = $annotation->web()->matchingImages(); -$firstImage = $matchingImages[0]; -``` - - - - - - - - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - \Google\Cloud\Vision\Annotation\AbstractFeature - - + + getFeatures + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::getFeatures() + + + Required. Requested features. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Feature>"/> - + - - - __construct - \Google\Cloud\Vision\Annotation\Web\WebImage::__construct() + + setFeatures + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::setFeatures() - - info + + var - array + \Google\Cloud\Vision\V1\Feature[] - - - + + Required. Requested features. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\Feature[]"/> + - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + getImageContext + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::getImageContext() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + Additional context that may accompany the image(s) in the file. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> - - + type="\Google\Cloud\Vision\V1\ImageContext|null"/> + - - url - \Google\Cloud\Vision\Annotation\Web\WebImage::url() + + hasImageContext + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::hasImageContext() - + - { -The result image URL - - + + - - score - \Google\Cloud\Vision\Annotation\Web\WebImage::score() + + clearImageContext + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::clearImageContext() - + - { -Overall relevancy score for the image. + + + + + + + setImageContext + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::setImageContext() + + + var + + \Google\Cloud\Vision\V1\ImageContext + + + + Additional context that may accompany the image(s) in the file. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + - + type="$this"/> + - - - - - - - - - Copyright 2016 Google Inc. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at + + getOutputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::getOutputConfig() + + + Required. The desired output location and metadata (e.g. format). + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 4;</code> + + + + + + + hasOutputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::hasOutputConfig() + + + + + + + + + + clearOutputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::clearOutputConfig() + + + + + + + + + + setOutputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::setOutputConfig() + + + var + + \Google\Cloud\Vision\V1\OutputConfig + + + + Required. The desired output location and metadata (e.g. format). + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 4;</code> + + + - http://www.apache.org/licenses/LICENSE-2.0 + -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + + + + + + + + + - + - - WebPage - \Google\Cloud\Vision\Annotation\Web\WebPage - - Represents a Web Page from a Web Detection operation. - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/eiffel-tower.jpg', 'r'); -$image = $vision->image($imageResource, ['WEB_DETECTION']); -$annotation = $vision->annotate($image); - -$pages = $annotation->web()->pages(); -$firstPage = $pages[0]; -``` + + + AsyncAnnotateFileResponse + \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse + + The response for a single offline file annotation request. + Generated from protobuf message <code>google.cloud.vision.v1.AsyncAnnotateFileResponse</code> - - - - - \Google\Cloud\Vision\Annotation\AbstractFeature + \Google\Protobuf\Internal\Message - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info - - \Google\Cloud\Vision\Annotation\AbstractFeature - - - - + + output_config + \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::$output_config + null + + The output location and metadata from AsyncAnnotateFileRequest. + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> + - - + + __construct - \Google\Cloud\Vision\Annotation\Web\WebPage::__construct() + \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::__construct() - - info - + + data + null array - - + + Constructor. + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\OutputConfig $output_config The output location and metadata from AsyncAnnotateFileRequest. }" + variable="data" type="array"/> - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + getOutputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::getOutputConfig() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + The output location and metadata from AsyncAnnotateFileRequest. + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> - - + type="\Google\Cloud\Vision\V1\OutputConfig|null"/> + - - url - \Google\Cloud\Vision\Annotation\Web\WebPage::url() + + hasOutputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::hasOutputConfig() - + - { -The result web page URL - - + + - - score - \Google\Cloud\Vision\Annotation\Web\WebPage::score() + + clearOutputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::clearOutputConfig() - + - { -Overall relevancy score for the image. + + + + + + + setOutputConfig + \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::setOutputConfig() + + + var + + \Google\Cloud\Vision\V1\OutputConfig + + + + The output location and metadata from AsyncAnnotateFileRequest. + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> + - + type="$this"/> + - + - + - Copyright 2016 Google Inc. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - Web - \Google\Cloud\Vision\Annotation\Web - - Represents a Web Detection result - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = $vision->image($imageResource, [ 'WEB_DETECTION' ]); -$annotation = $vision->annotate($image); - -$web = $annotation->web(); -``` + + + AsyncBatchAnnotateFilesRequest + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest + + Multiple async file annotation requests are batched into a single service +call. + Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateFilesRequest</code> - - - \Google\Cloud\Vision\Annotation\AbstractFeature + \Google\Protobuf\Internal\Message - - entities - \Google\Cloud\Vision\Annotation\Web::$entities + + requests + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::$requests - - - - - + + Required. Individual async file annotation requests for this batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + - - matchingImages - \Google\Cloud\Vision\Annotation\Web::$matchingImages - - - - - - + + parent + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::$parent + '' + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 4;</code> + - - partialMatchingImages - \Google\Cloud\Vision\Annotation\Web::$partialMatchingImages + + labels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::$labels - - - - - + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + - - pages - \Google\Cloud\Vision\Annotation\Web::$pages - - - - - - - - - - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::$info + + + build + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::build() + + + requests - \Google\Cloud\Vision\Annotation\AbstractFeature + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[] + + + + + type="\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest"/> + - + - - + __construct - \Google\Cloud\Vision\Annotation\Web::__construct() + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::__construct() - - info - + + data + null array - - Create a Web result. + + Constructor. + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[] $requests Required. Individual async file annotation requests for this batch. @type string $parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. @type array|\Google\Protobuf\Internal\MapField $labels Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. }" + variable="data" type="array"/> - - entities - \Google\Cloud\Vision\Annotation\Web::entities() + + getRequests + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getRequests() - - Entities deduced from similar images on the Internet. - Example: -``` -$entities = $web->entities(); -``` + + Required. Individual async file annotation requests for this batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\AsyncAnnotateFileRequest>"/> + - - matchingImages - \Google\Cloud\Vision\Annotation\Web::matchingImages() + + setRequests + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setRequests() - - Fully matching images from the internet. - Images are most likely near duplicates, and most often are a copy of the -given query image with a size change. + + var + + \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[] + -Example: -``` -$images = $web->matchingImages(); -``` + + Required. Individual async file annotation requests for this batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + - + type="$this"/> + - - partialMatchingImages - \Google\Cloud\Vision\Annotation\Web::partialMatchingImages() + + getParent + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getParent() - - Partial matching images from the Internet. - Those images are similar enough to share some key-point features. For -example an original image will likely have partial matching for its crops. + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. -Example: -``` -$images = $web->partialMatchingImages(); -``` +Generated from protobuf field <code>string parent = 4;</code> - + type="string"/> + - - pages - \Google\Cloud\Vision\Annotation\Web::pages() + + setParent + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setParent() - - Web pages containing the matching images from the Internet. - Example: -``` -$pages = $web->pages(); -``` + + var + + string + + + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 4;</code> + - + type="$this"/> + - - info - \Google\Cloud\Vision\Annotation\AbstractFeature::info() + + getLabels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getLabels() - \Google\Cloud\Vision\Annotation\AbstractFeature - Get the raw annotation result - Example: -``` -$info = $imageProperties->info(); -``` + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + type="\Google\Protobuf\Internal\MapField"/> + + + + + + setLabels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setLabels() + + + var + + array|\Google\Protobuf\Internal\MapField + + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + - + name="return" + description="" + type="$this"/> + - + - + - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - Annotation - \Google\Cloud\Vision\Annotation - - Represents a [Google Cloud Vision](https://cloud.google.com/vision) image -annotation result. - Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = $vision->image($imageResource, [ - 'FACE_DETECTION' -]); - -$annotation = $vision->annotate($image); -``` + + + AsyncBatchAnnotateFilesResponse + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse + + Response to an async batch file annotation request. + Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse</code> - - + \Google\Protobuf\Internal\Message - - info - \Google\Cloud\Vision\Annotation::$info + + responses + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse::$responses - - - - - + + The list of file annotation responses, one for each request in +AsyncBatchAnnotateFilesRequest. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileResponse responses = 1;</code> + - - faces - \Google\Cloud\Vision\Annotation::$faces - - - + + + __construct + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse::__construct() + + + data + null + array + + + + Constructor. + name="param" + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse[] $responses The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. }" + variable="data" type="array"/> - + - - landmarks - \Google\Cloud\Vision\Annotation::$landmarks - - - - + + getResponses + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse::getResponses() + + + The list of file annotation responses, one for each request in +AsyncBatchAnnotateFilesRequest. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileResponse responses = 1;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\AsyncAnnotateFileResponse>"/> - + - - logos - \Google\Cloud\Vision\Annotation::$logos + + setResponses + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse::setResponses() + + + var - - - + \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse[] + + + + The list of file annotation responses, one for each request in +AsyncBatchAnnotateFilesRequest. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileResponse responses = 1;</code> - - - - - - labels - \Google\Cloud\Vision\Annotation::$labels - - - - - + + type="$this"/> - + - - text - \Google\Cloud\Vision\Annotation::$text - - + + + + + + + + - + name="package" + description="Application" + /> + - - - fullText - \Google\Cloud\Vision\Annotation::$fullText - - - - + + + + + + + + + + AsyncBatchAnnotateImagesRequest + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest + + Request for async image annotation for a list of images. + Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateImagesRequest</code> + name="package" + description="Application" + /> - - - - safeSearch - \Google\Cloud\Vision\Annotation::$safeSearch + \Google\Protobuf\Internal\Message + + + + requests + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::$requests - - - - - + + Required. Individual image annotation requests for this batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + - - imageProperties - \Google\Cloud\Vision\Annotation::$imageProperties - - - - - - + + output_config + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::$output_config + null + + Required. The desired output location and metadata (e.g. format). + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> + - - cropHints - \Google\Cloud\Vision\Annotation::$cropHints - - - - - - + + parent + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::$parent + '' + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 4;</code> + - - web - \Google\Cloud\Vision\Annotation::$web + + labels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::$labels - - - - - + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + - - error - \Google\Cloud\Vision\Annotation::$error + + + build + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::build() + + + requests - + \Google\Cloud\Vision\V1\AnnotateImageRequest[] + + + + outputConfig + + \Google\Cloud\Vision\V1\OutputConfig + + + + + + + /> - + - - + __construct - \Google\Cloud\Vision\Annotation::__construct() + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::__construct() - - info - + + data + null array - - Create an annotation result. - This class represents a single image annotation response from Cloud Vision. If multiple images were tested at -once, the result will be an array of Annotation instances. - -This class is not intended to be instantiated outside the Google Cloud Platform Client Library. + + Constructor. + + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\AnnotateImageRequest[] $requests Required. Individual image annotation requests for this batch. @type \Google\Cloud\Vision\V1\OutputConfig $output_config Required. The desired output location and metadata (e.g. format). @type string $parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. @type array|\Google\Protobuf\Internal\MapField $labels Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. }" + variable="data" type="array"/> - - info - \Google\Cloud\Vision\Annotation::info() + + getRequests + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getRequests() - - Return raw annotation response array - Example: -``` -$info = $annotation->info(); -``` + + Required. Individual image annotation requests for this batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - - - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\AnnotateImageRequest>"/> + - - faces - \Google\Cloud\Vision\Annotation::faces() + + setRequests + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setRequests() - - Return an array of faces - Example: -``` -$faces = $annotation->faces(); -``` - - - - - + + var + + \Google\Cloud\Vision\V1\AnnotateImageRequest[] + - - landmarks - \Google\Cloud\Vision\Annotation::landmarks() - - - Return an array of landmarks - Example: -``` -$landmarks = $annotation->landmarks(); -``` + + Required. Individual image annotation requests for this batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + name="param" + description="" + variable="var" type="\Google\Cloud\Vision\V1\AnnotateImageRequest[]"/> - + type="$this"/> + - - logos - \Google\Cloud\Vision\Annotation::logos() + + getOutputConfig + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getOutputConfig() - - Return an array of logos - Example: -``` -$logos = $annotation->logos(); -``` + + Required. The desired output location and metadata (e.g. format). + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - + type="\Google\Cloud\Vision\V1\OutputConfig|null"/> + - - labels - \Google\Cloud\Vision\Annotation::labels() + + hasOutputConfig + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::hasOutputConfig() - - Return an array of labels - Example: -``` -$labels = $annotation->labels(); -``` - - - + + + + - - text - \Google\Cloud\Vision\Annotation::text() + + clearOutputConfig + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::clearOutputConfig() - - Return an array containing all text found in the image - Example: -``` -$text = $annotation->text(); -``` - - - + + + + - - fullText - \Google\Cloud\Vision\Annotation::fullText() + + setOutputConfig + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setOutputConfig() - - Return the full text annotation. - Example: -``` -$fullText = $annotation->fullText(); -``` - - - - - + + var + + \Google\Cloud\Vision\V1\OutputConfig + - - safeSearch - \Google\Cloud\Vision\Annotation::safeSearch() - - - Get the result of a safe search detection - Example: -``` -$safeSearch = $annotation->safeSearch(); -``` + + Required. The desired output location and metadata (e.g. format). + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - + variable="var" type="\Google\Cloud\Vision\V1\OutputConfig"/> - + type="$this"/> + - - imageProperties - \Google\Cloud\Vision\Annotation::imageProperties() + + getParent + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getParent() - - Fetch image properties - Example: -``` -$properties = $annotation->imageProperties(); -``` + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 4;</code> - - + type="string"/> + - - cropHints - \Google\Cloud\Vision\Annotation::cropHints() + + setParent + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setParent() - - Fetch Crop Hints - Example: -``` -$hints = $annotation->cropHints(); -``` + + var + + string + + + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 4;</code> - - + variable="var" type="string"/> - + type="$this"/> + - - web - \Google\Cloud\Vision\Annotation::web() + + getLabels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getLabels() - - Fetch the Web Annotatation. - Example: -``` -$web = $annotation->web(); -``` + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> - - + type="\Google\Protobuf\Internal\MapField"/> + - - error - \Google\Cloud\Vision\Annotation::error() + + setLabels + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setLabels() - - Get error information, if present - Example: -``` -$error = $annotation->error(); -``` + + var + + array|\Google\Protobuf\Internal\MapField + + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + name="param" + description="" + variable="var" type="array|\Google\Protobuf\Internal\MapField"/> - + type="$this"/> + @@ -4326,20 +3353,10 @@ $error = $annotation->error(); - + - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - ConnectionInterface - \Google\Cloud\Vision\Connection\ConnectionInterface - - Represents a connection to -[Cloud Vision](https://cloud.google.com/vision). - + + + + AsyncBatchAnnotateImagesResponse + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse + + Response to an async batch image annotation request. + Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateImagesResponse</code> - - + + + \Google\Protobuf\Internal\Message + + + + output_config + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::$output_config + null + + The output location and metadata from AsyncBatchAnnotateImagesRequest. + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> + + + - - annotate - \Google\Cloud\Vision\Connection\ConnectionInterface::annotate() + + + __construct + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::__construct() - - args - + + data + null array - - + + Constructor. + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\OutputConfig $output_config The output location and metadata from AsyncBatchAnnotateImagesRequest. }" + variable="data" type="array"/> - - - - - - - - - - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - - - - - - - - - - - - Rest - \Google\Cloud\Vision\Connection\Rest - - Implementation of the -[Google Cloud Vision JSON API](https://cloud.google.com/vision/reference/rest/). - + + getOutputConfig + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::getOutputConfig() + + + The output location and metadata from AsyncBatchAnnotateImagesRequest. + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> - + name="return" + description="" + type="\Google\Cloud\Vision\V1\OutputConfig|null"/> - - \Google\Cloud\Vision\Connection\ConnectionInterface - - - BASE_URI - \Google\Cloud\Vision\Connection\Rest::BASE_URI - 'https://vision.googleapis.com/' - + + + + hasOutputConfig + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::hasOutputConfig() + + - + - + - - - - __construct - \Google\Cloud\Vision\Connection\Rest::__construct() + + clearOutputConfig + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::clearOutputConfig() - - config - [] - array - - - + - - + - - annotate - \Google\Cloud\Vision\Connection\Rest::annotate() + + setOutputConfig + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::setOutputConfig() - - args + + var - array + \Google\Cloud\Vision\V1\OutputConfig - - - + + The output location and metadata from AsyncBatchAnnotateImagesRequest. + Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\OutputConfig"/> + @@ -4507,20 +3488,10 @@ limitations under the License. - + - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - Image - \Google\Cloud\Vision\Image - - Represents an image to be annotated using -[Google Cloud Vision](https://cloud.google.com/vision). - Please review [Pricing](https://cloud.google.com/vision/docs/pricing) -before use, as a separate charge is incurred for each feature performed -on an image. When practical, caching of results is certainly recommended. - -The Cloud Vision API supports a variety of image file formats, including -JPEG, PNG8, PNG24, Animated GIF (first frame only), and RAW. - -Cloud Vision sets upper limits on file size as well as on the total -combined size of all images in a request. Reducing your file size can -significantly improve throughput; however, be careful not to reduce image -quality in the process. See -[Best Practices - Image Sizing](https://cloud.google.com/vision/docs/best-practices#image_sizing) -for current file size limits. - -Example: -``` -//[snippet=default] -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = $vision->image($imageResource, [ - 'FACE_DETECTION' -]); -``` - -``` -//[snippet=direct] -// Images can be directly instantiated. -use Google\Cloud\Vision\Image; - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = new Image($imageResource, [ - 'FACE_DETECTION' -]); -``` - -``` -//[snippet=string] -// Image data can be given as a string - -use Google\Cloud\Vision\Image; - -$imageData = file_get_contents(__DIR__ .'/assets/family-photo.jpg'); -$image = new Image($imageData, [ - 'FACE_DETECTION' -]); -``` - -``` -//[snippet=gcs] -// Files stored in Google Cloud Storage can be used. -use Google\Cloud\Storage\StorageClient; -use Google\Cloud\Vision\Image; - -$storage = new StorageClient(); -$file = $storage->bucket('my-test-bucket')->object('family-photo.jpg'); -$image = new Image($file, [ - 'FACE_DETECTION' -]); -``` - -``` -//[snippet=max] -// This example sets a maximum results limit on one feature and provides some image context. - -use Google\Cloud\Vision\Image; - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = new Image($imageResource, [ - 'FACE_DETECTION', - 'LOGO_DETECTION' -], [ - 'maxResults' => [ - 'FACE_DETECTION' => 1 - ], - 'imageContext' => [ - 'latLongRect' => [ - 'minLatLng' => [ - 'latitude' => '-45.0', - 'longitude' => '-45.0' - ], - 'maxLatLng' => [ - 'latitude' => '45.0', - 'longitude' => '45.0' - ] - ] - ] -]); -``` - -``` -//[snippet=shortcut] -// The client library also offers shortcut names which can be used in place of the longer feature names. - -use Google\Cloud\Vision\Image; - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = new Image($imageResource, [ - 'faces', // Corresponds to `FACE_DETECTION` - 'landmarks', // Corresponds to `LANDMARK_DETECTION` - 'logos', // Corresponds to `LOGO_DETECTION` - 'labels', // Corresponds to `LABEL_DETECTION` - 'text', // Corresponds to `TEXT_DETECTION`, - 'document', // Corresponds to `DOCUMENT_TEXT_DETECTION` - 'safeSearch', // Corresponds to `SAFE_SEARCH_DETECTION` - 'imageProperties',// Corresponds to `IMAGE_PROPERTIES` - 'crop', // Corresponds to `CROP_HINTS` - 'web' // Corresponds to `WEB_DETECTION` -]); -``` - - - - + BatchAnnotateFilesRequest + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest + + A list of requests to annotate files using the BatchAnnotateFiles API. + Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateFilesRequest</code> + + \Google\Protobuf\Internal\Message - - - TYPE_BYTES - \Google\Cloud\Vision\Image::TYPE_BYTES - 'bytes' - - - - - - - - - TYPE_STRING - \Google\Cloud\Vision\Image::TYPE_STRING - 'string' - - - - - - - - - TYPE_URI - \Google\Cloud\Vision\Image::TYPE_URI - 'uri' - - - - - - - - - image - \Google\Cloud\Vision\Image::$image + + requests + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::$requests - - - - - + + Required. The list of file annotation requests. Right now we support only +one AnnotateFileRequest in BatchAnnotateFilesRequest. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + - - type - \Google\Cloud\Vision\Image::$type - - - - - - + + parent + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::$parent + '' + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 3;</code> + - - features - \Google\Cloud\Vision\Image::$features + + labels + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::$labels - - - - - + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + - - options - \Google\Cloud\Vision\Image::$options + + + build + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::build() + + + requests - - - - - - - + \Google\Cloud\Vision\V1\AnnotateFileRequest[] + - - featureShortNames - \Google\Cloud\Vision\Image::$featureShortNames - ['faces' => 'FACE_DETECTION', 'landmarks' => 'LANDMARK_DETECTION', 'logos' => 'LOGO_DETECTION', 'labels' => 'LABEL_DETECTION', 'text' => 'TEXT_DETECTION', 'document' => 'DOCUMENT_TEXT_DETECTION', 'safeSearch' => 'SAFE_SEARCH_DETECTION', 'imageProperties' => 'IMAGE_PROPERTIES', 'crop' => 'CROP_HINTS', 'web' => 'WEB_DETECTION'] - - A map of short names to identifiers recognized by Cloud Vision. + + + - - - - - - urlSchemes - \Google\Cloud\Vision\Image::$urlSchemes - ['http', 'https', 'gs'] - - A list of allowed url schemes. - - + + /> - + - - + __construct - \Google\Cloud\Vision\Image::__construct() + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::__construct() - - image - - resource|string|\Google\Cloud\Storage\StorageObject - - - - features - - array - - - - options - [] + + data + null array - - Create an image with all required configuration. + + Constructor. - - - + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\AnnotateFileRequest[] $requests Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. @type string $parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. @type array|\Google\Protobuf\Internal\MapField $labels Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. }" + variable="data" type="array"/> - - requestObject - \Google\Cloud\Vision\Image::requestObject() + + getRequests + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getRequests() - - encode - true - bool - - - - Return a formatted annotate image request. - This method is used internally by {@see \Google\Cloud\Vision\VisionClient} -and is not generally intended for use outside of that context. - -Example: -``` -use Google\Cloud\Vision\Image; - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$image = new Image($imageResource, [ - 'FACE_DETECTION' -]); - -$requestObj = $image->requestObject(); -``` + + Required. The list of file annotation requests. Right now we support only +one AnnotateFileRequest in BatchAnnotateFilesRequest. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\AnnotateFileRequest>"/> - - imageObject - \Google\Cloud\Vision\Image::imageObject() + + setRequests + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setRequests() - - encode + + var - bool + \Google\Cloud\Vision\V1\AnnotateFileRequest[] - - Create an image object. - The structure of the returned array will vary depending on whether the -given image is a storage object or not. + + Required. The list of file annotation requests. Right now we support only +one AnnotateFileRequest in BatchAnnotateFilesRequest. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - + description="" + variable="var" type="\Google\Cloud\Vision\V1\AnnotateFileRequest[]"/> + description="" + type="$this"/> - - normalizeFeatures - \Google\Cloud\Vision\Image::normalizeFeatures() + + getParent + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getParent() - - features - - array - + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. - - Normalizes short feature names to identifiers compatible with the vision -API and adds maxResults if specified. - +Generated from protobuf field <code>string parent = 3;</code> - + description="" + type="string"/> - - maxResult - \Google\Cloud\Vision\Image::maxResult() + + setParent + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setParent() - - feature + + var string - - Identify and return a maxResults value for a given feature, if maxResults -is specified. - + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 3;</code> + variable="var" type="string"/> + description="" + type="$this"/> - - - - - - - - - - - - - - - - - + + getLabels + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getLabels() + + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. - - - - - AddProductToProductSetRequest - \Google\Cloud\Vision\V1\AddProductToProductSetRequest - - Request message for the `AddProductToProductSet` method. - Generated from protobuf message <code>google.cloud.vision.v1.AddProductToProductSetRequest</code> +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + name="return" + description="" + type="\Google\Protobuf\Internal\MapField"/> - \Google\Protobuf\Internal\Message - - - - name - \Google\Cloud\Vision\V1\AddProductToProductSetRequest::$name - '' - - Required. The resource name for the ProductSet to modify. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - product - \Google\Cloud\Vision\V1\AddProductToProductSetRequest::$product - '' - - Required. The resource name for the Product to be added to this ProductSet. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - + - - - build - \Google\Cloud\Vision\V1\AddProductToProductSetRequest::build() + + setLabels + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setLabels() - - name + + var - string + array|\Google\Protobuf\Internal\MapField - - product - - string - + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. - - - +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> - - + variable="var" type="array|\Google\Protobuf\Internal\MapField"/> + type="$this"/> - - __construct - \Google\Cloud\Vision\V1\AddProductToProductSetRequest::__construct() - - - data - NULL - array - - - - Constructor. + + + + + + + + + - + name="package" + description="Application" + /> + - - - getName - \Google\Cloud\Vision\V1\AddProductToProductSetRequest::getName() - - - Required. The resource name for the ProductSet to modify. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + + + -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + BatchAnnotateFilesResponse + \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse + + A list of file annotation responses. + Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateFilesResponse</code> + name="package" + description="Application" + /> - + \Google\Protobuf\Internal\Message + + + + responses + \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse::$responses + + + The list of file annotation responses, each response corresponding to each +AnnotateFileRequest in BatchAnnotateFilesRequest. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileResponse responses = 1;</code> + - - setName - \Google\Cloud\Vision\V1\AddProductToProductSetRequest::setName() + + + + + __construct + \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse::__construct() - - var - - string + + data + null + array - - Required. The resource name for the ProductSet to modify. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\AnnotateFileResponse[] $responses The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. }" + variable="data" type="array"/> - - getProduct - \Google\Cloud\Vision\V1\AddProductToProductSetRequest::getProduct() + + getResponses + \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse::getResponses() - - Required. The resource name for the Product to be added to this ProductSet. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + The list of file annotation responses, each response corresponding to each +AnnotateFileRequest in BatchAnnotateFilesRequest. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileResponse responses = 1;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\AnnotateFileResponse>"/> - - setProduct - \Google\Cloud\Vision\V1\AddProductToProductSetRequest::setProduct() + + setResponses + \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse::setResponses() - + var - string + \Google\Cloud\Vision\V1\AnnotateFileResponse[] - - Required. The resource name for the Product to be added to this ProductSet. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + The list of file annotation responses, each response corresponding to each +AnnotateFileRequest in BatchAnnotateFilesRequest. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileResponse responses = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\AnnotateFileResponse[]"/> - + @@ -5211,12 +3908,13 @@ Generated from protobuf field <code>string product = 2 [(.google.api.field + - AnnotateFileRequest - \Google\Cloud\Vision\V1\AnnotateFileRequest + BatchAnnotateImagesRequest + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest - A request to annotate one single file, e.g. a PDF, TIFF or GIF file. - Generated from protobuf message <code>google.cloud.vision.v1.AnnotateFileRequest</code> + Multiple image annotation requests are batched into a single service call. + Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateImagesRequest</code> \Google\Protobuf\Internal\Message - - input_config - \Google\Cloud\Vision\V1\AnnotateFileRequest::$input_config - null + + requests + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::$requests + - Required. Information about the input file. - Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> - - - - - - features - \Google\Cloud\Vision\V1\AnnotateFileRequest::$features - - - Required. Requested features. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + Required. Individual image annotation requests for this batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - image_context - \Google\Cloud\Vision\V1\AnnotateFileRequest::$image_context - null - - Additional context that may accompany the image(s) in the file. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + parent + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::$parent + '' + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 4;</code> - - pages - \Google\Cloud\Vision\V1\AnnotateFileRequest::$pages + + labels + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::$labels - - Pages of the file to perform image annotation. - Pages starts from 1, we assume the first page of the file is page 1. -At most 5 pages are supported per request. Pages can be negative. -Page 1 means the first page. -Page 2 means the second page. -Page -1 means the last page. -Page -2 means the second to the last page. -If the file is GIF instead of PDF or TIFF, page refers to GIF frames. -If this field is empty, by default the service performs image annotation -for the first 5 pages of the file. + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. -Generated from protobuf field <code>repeated int32 pages = 4;</code> +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> - + + build + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::build() + + + requests + + \Google\Cloud\Vision\V1\AnnotateImageRequest[] + + + + + + + + + + + + + __construct - \Google\Cloud\Vision\V1\AnnotateFileRequest::__construct() + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::__construct() - + data - NULL + null array - + Constructor. - - getInputConfig - \Google\Cloud\Vision\V1\AnnotateFileRequest::getInputConfig() + + getRequests + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getRequests() - - Required. Information about the input file. - Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + + Required. Individual image annotation requests for this batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\AnnotateImageRequest>"/> - - hasInputConfig - \Google\Cloud\Vision\V1\AnnotateFileRequest::hasInputConfig() - - - - - - - - - - clearInputConfig - \Google\Cloud\Vision\V1\AnnotateFileRequest::clearInputConfig() - - - - - - - - - - setInputConfig - \Google\Cloud\Vision\V1\AnnotateFileRequest::setInputConfig() + + setRequests + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setRequests() - + var - \Google\Cloud\Vision\V1\InputConfig + \Google\Cloud\Vision\V1\AnnotateImageRequest[] - - Required. Information about the input file. - Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + + Required. Individual image annotation requests for this batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + variable="var" type="\Google\Cloud\Vision\V1\AnnotateImageRequest[]"/> - - getFeatures - \Google\Cloud\Vision\V1\AnnotateFileRequest::getFeatures() + + getParent + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getParent() - - Required. Requested features. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 4;</code> + type="string"/> - - setFeatures - \Google\Cloud\Vision\V1\AnnotateFileRequest::setFeatures() + + setParent + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setParent() - + var - \Google\Cloud\Vision\V1\Feature[]|\Google\Protobuf\Internal\RepeatedField + string - - Required. Requested features. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + + Optional. Target project and location to make a call. + Format: `projects/{project-id}/locations/{location-id}`. +If no parent is specified, a region will be chosen automatically. +Supported location-ids: + `us`: USA country only, + `asia`: East asia areas, like Japan, Taiwan, + `eu`: The European Union. +Example: `projects/project-A/locations/eu`. + +Generated from protobuf field <code>string parent = 4;</code> + variable="var" type="string"/> - - getImageContext - \Google\Cloud\Vision\V1\AnnotateFileRequest::getImageContext() + + getLabels + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getLabels() - - Additional context that may accompany the image(s) in the file. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + type="\Google\Protobuf\Internal\MapField"/> - - hasImageContext - \Google\Cloud\Vision\V1\AnnotateFileRequest::hasImageContext() - - - - - - - - - - clearImageContext - \Google\Cloud\Vision\V1\AnnotateFileRequest::clearImageContext() - - - - - - - - - - setImageContext - \Google\Cloud\Vision\V1\AnnotateFileRequest::setImageContext() + + setLabels + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setLabels() - + var - \Google\Cloud\Vision\V1\ImageContext + array|\Google\Protobuf\Internal\MapField - - Additional context that may accompany the image(s) in the file. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters +(Unicode codepoints), can only contain lowercase letters, numeric +characters, underscores and dashes. International characters are allowed. +Label values are optional. Label keys must start with a letter. + +Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> - - - - - - - getPages - \Google\Cloud\Vision\V1\AnnotateFileRequest::getPages() - - - Pages of the file to perform image annotation. - Pages starts from 1, we assume the first page of the file is page 1. -At most 5 pages are supported per request. Pages can be negative. -Page 1 means the first page. -Page 2 means the second page. -Page -1 means the last page. -Page -2 means the second to the last page. -If the file is GIF instead of PDF or TIFF, page refers to GIF frames. -If this field is empty, by default the service performs image annotation -for the first 5 pages of the file. - -Generated from protobuf field <code>repeated int32 pages = 4;</code> - - - - - - - setPages - \Google\Cloud\Vision\V1\AnnotateFileRequest::setPages() - - - var - - int[]|\Google\Protobuf\Internal\RepeatedField - - - - Pages of the file to perform image annotation. - Pages starts from 1, we assume the first page of the file is page 1. -At most 5 pages are supported per request. Pages can be negative. -Page 1 means the first page. -Page 2 means the second page. -Page -1 means the last page. -Page -2 means the second to the last page. -If the file is GIF instead of PDF or TIFF, page refers to GIF frames. -If this field is empty, by default the service performs image annotation -for the first 5 pages of the file. - -Generated from protobuf field <code>repeated int32 pages = 4;</code> - + variable="var" type="array|\Google\Protobuf\Internal\MapField"/> - + @@ -5550,13 +4191,13 @@ Generated from protobuf field <code>repeated int32 pages = 4;</code> - - AnnotateFileResponse - \Google\Cloud\Vision\V1\AnnotateFileResponse - - Response to a single file annotation request. A file may contain one or more -images, which individually have their own responses. - Generated from protobuf message <code>google.cloud.vision.v1.AnnotateFileResponse</code> + + + BatchAnnotateImagesResponse + \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse + + Response to a batch image annotation request. + Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateImagesResponse</code> \Google\Protobuf\Internal\Message - - input_config - \Google\Cloud\Vision\V1\AnnotateFileResponse::$input_config - null - - Information about the file for which this response is generated. - Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> - - - - - + responses - \Google\Cloud\Vision\V1\AnnotateFileResponse::$responses + \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse::$responses - - Individual responses to images found within the file. This field will be -empty if the `error` field is set. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;</code> - - - - - - total_pages - \Google\Cloud\Vision\V1\AnnotateFileResponse::$total_pages - 0 - - This field gives the total number of pages in the file. - Generated from protobuf field <code>int32 total_pages = 3;</code> - - - - - - error - \Google\Cloud\Vision\V1\AnnotateFileResponse::$error - null - - If set, represents the error message for the failed request. The -`responses` field will not be set in this case. - Generated from protobuf field <code>.google.rpc.Status error = 4;</code> + + Individual responses to image annotation requests within the batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 1;</code> - + __construct - \Google\Cloud\Vision\V1\AnnotateFileResponse::__construct() + \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse::__construct() - + data - NULL + null array - + Constructor. - - getInputConfig - \Google\Cloud\Vision\V1\AnnotateFileResponse::getInputConfig() + + getResponses + \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse::getResponses() - - Information about the file for which this response is generated. - Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + + Individual responses to image annotation requests within the batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 1;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\AnnotateImageResponse>"/> - - hasInputConfig - \Google\Cloud\Vision\V1\AnnotateFileResponse::hasInputConfig() - - - - - - - - - - clearInputConfig - \Google\Cloud\Vision\V1\AnnotateFileResponse::clearInputConfig() - - - - - - - - - - setInputConfig - \Google\Cloud\Vision\V1\AnnotateFileResponse::setInputConfig() + + setResponses + \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse::setResponses() - + var - \Google\Cloud\Vision\V1\InputConfig + \Google\Cloud\Vision\V1\AnnotateImageResponse[] - - Information about the file for which this response is generated. - Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + + Individual responses to image annotation requests within the batch. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\AnnotateImageResponse[]"/> - - getResponses - \Google\Cloud\Vision\V1\AnnotateFileResponse::getResponses() - - - Individual responses to images found within the file. This field will be -empty if the `error` field is set. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;</code> + + + + + + + + + + - + name="package" + description="Application" + /> + - - - setResponses - \Google\Cloud\Vision\V1\AnnotateFileResponse::setResponses() - - - var - - \Google\Cloud\Vision\V1\AnnotateImageResponse[]|\Google\Protobuf\Internal\RepeatedField - + + + - - Individual responses to images found within the file. This field will be -empty if the `error` field is set. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 2;</code> + + + + + + State + \Google\Cloud\Vision\V1\BatchOperationMetadata\State + + Enumerates the possible states that the batch request can be in. + Protobuf type <code>google.cloud.vision.v1.BatchOperationMetadata.State</code> - + name="package" + description="Application" + /> - + + + + STATE_UNSPECIFIED + \Google\Cloud\Vision\V1\BatchOperationMetadata\State::STATE_UNSPECIFIED + 0 + + Invalid. + Generated from protobuf enum <code>STATE_UNSPECIFIED = 0;</code> + - - getTotalPages - \Google\Cloud\Vision\V1\AnnotateFileResponse::getTotalPages() - - - This field gives the total number of pages in the file. - Generated from protobuf field <code>int32 total_pages = 3;</code> - - + - + + PROCESSING + \Google\Cloud\Vision\V1\BatchOperationMetadata\State::PROCESSING + 1 + + Request is actively being processed. + Generated from protobuf enum <code>PROCESSING = 1;</code> + - - setTotalPages - \Google\Cloud\Vision\V1\AnnotateFileResponse::setTotalPages() - - - var - - int - + - - This field gives the total number of pages in the file. - Generated from protobuf field <code>int32 total_pages = 3;</code> - - - + + SUCCESSFUL + \Google\Cloud\Vision\V1\BatchOperationMetadata\State::SUCCESSFUL + 2 + + The request is done and at least one item has been successfully +processed. + Generated from protobuf enum <code>SUCCESSFUL = 2;</code> + - + - - getError - \Google\Cloud\Vision\V1\AnnotateFileResponse::getError() - - - If set, represents the error message for the failed request. The -`responses` field will not be set in this case. - Generated from protobuf field <code>.google.rpc.Status error = 4;</code> - - + + FAILED + \Google\Cloud\Vision\V1\BatchOperationMetadata\State::FAILED + 3 + + The request is done and no item has been successfully processed. + Generated from protobuf enum <code>FAILED = 3;</code> + - + - - hasError - \Google\Cloud\Vision\V1\AnnotateFileResponse::hasError() - - + + CANCELLED + \Google\Cloud\Vision\V1\BatchOperationMetadata\State::CANCELLED + 4 + + The request is done after the longrunning.Operations.CancelOperation has +been called by the user. Any records that were processed before the +cancel command are output as specified in the request. + Generated from protobuf enum <code>CANCELLED = 4;</code> + + + + + + + valueToName + \Google\Cloud\Vision\V1\BatchOperationMetadata\State::$valueToName + [self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', self::PROCESSING => 'PROCESSING', self::SUCCESSFUL => 'SUCCESSFUL', self::FAILED => 'FAILED', self::CANCELLED => 'CANCELLED'] + - + - + - - clearError - \Google\Cloud\Vision\V1\AnnotateFileResponse::clearError() + + + name + \Google\Cloud\Vision\V1\BatchOperationMetadata\State::name() - + + value + + mixed + + + - + - - setError - \Google\Cloud\Vision\V1\AnnotateFileResponse::setError() + + value + \Google\Cloud\Vision\V1\BatchOperationMetadata\State::value() - - var + + name - \Google\Rpc\Status + mixed - - If set, represents the error message for the failed request. The -`responses` field will not be set in this case. - Generated from protobuf field <code>.google.rpc.Status error = 4;</code> - - - + + + + @@ -5848,7 +4430,7 @@ empty if the `error` field is set. - + @@ -5866,13 +4448,16 @@ empty if the `error` field is set. - - AnnotateImageRequest - \Google\Cloud\Vision\V1\AnnotateImageRequest - - Request for performing Google Cloud Vision API tasks over a user-provided -image, with user-requested features, and with context information. - Generated from protobuf message <code>google.cloud.vision.v1.AnnotateImageRequest</code> + + + BatchOperationMetadata + \Google\Cloud\Vision\V1\BatchOperationMetadata + + Metadata for the batch operations such as the current state. + This is included in the `metadata` field of the `Operation` returned by the +`GetOperation` call of the `google::longrunning::Operations` service. + +Generated from protobuf message <code>google.cloud.vision.v1.BatchOperationMetadata</code> \Google\Protobuf\Internal\Message - - image - \Google\Cloud\Vision\V1\AnnotateImageRequest::$image - null - - The image to be processed. - Generated from protobuf field <code>.google.cloud.vision.v1.Image image = 1;</code> + + state + \Google\Cloud\Vision\V1\BatchOperationMetadata::$state + 0 + + The current state of the batch operation. + Generated from protobuf field <code>.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;</code> - - features - \Google\Cloud\Vision\V1\AnnotateImageRequest::$features - - - Requested features. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + + submit_time + \Google\Cloud\Vision\V1\BatchOperationMetadata::$submit_time + null + + The time when the batch request was submitted to the server. + Generated from protobuf field <code>.google.protobuf.Timestamp submit_time = 2;</code> - - image_context - \Google\Cloud\Vision\V1\AnnotateImageRequest::$image_context + + end_time + \Google\Cloud\Vision\V1\BatchOperationMetadata::$end_time null - - Additional context that may accompany the image. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + The time when the batch request is finished and +[google.longrunning.Operation.done][google.longrunning.Operation.done] is +set to true. + Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 3;</code> - + __construct - \Google\Cloud\Vision\V1\AnnotateImageRequest::__construct() + \Google\Cloud\Vision\V1\BatchOperationMetadata::__construct() - + data - NULL + null array - + Constructor. - - getImage - \Google\Cloud\Vision\V1\AnnotateImageRequest::getImage() + + getState + \Google\Cloud\Vision\V1\BatchOperationMetadata::getState() - - The image to be processed. - Generated from protobuf field <code>.google.cloud.vision.v1.Image image = 1;</code> + + The current state of the batch operation. + Generated from protobuf field <code>.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;</code> + type="int"/> - - hasImage - \Google\Cloud\Vision\V1\AnnotateImageRequest::hasImage() - - - - - - - - - - clearImage - \Google\Cloud\Vision\V1\AnnotateImageRequest::clearImage() - - - - - - - - - - setImage - \Google\Cloud\Vision\V1\AnnotateImageRequest::setImage() + + setState + \Google\Cloud\Vision\V1\BatchOperationMetadata::setState() - + var - \Google\Cloud\Vision\V1\Image + int - - The image to be processed. - Generated from protobuf field <code>.google.cloud.vision.v1.Image image = 1;</code> + + The current state of the batch operation. + Generated from protobuf field <code>.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;</code> + variable="var" type="int"/> - - getFeatures - \Google\Cloud\Vision\V1\AnnotateImageRequest::getFeatures() + + getSubmitTime + \Google\Cloud\Vision\V1\BatchOperationMetadata::getSubmitTime() - - Requested features. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + + The time when the batch request was submitted to the server. + Generated from protobuf field <code>.google.protobuf.Timestamp submit_time = 2;</code> + type="\Google\Protobuf\Timestamp|null"/> - - setFeatures - \Google\Cloud\Vision\V1\AnnotateImageRequest::setFeatures() + + hasSubmitTime + \Google\Cloud\Vision\V1\BatchOperationMetadata::hasSubmitTime() - + + + + + + + + + clearSubmitTime + \Google\Cloud\Vision\V1\BatchOperationMetadata::clearSubmitTime() + + + + + + + + + + setSubmitTime + \Google\Cloud\Vision\V1\BatchOperationMetadata::setSubmitTime() + + var - \Google\Cloud\Vision\V1\Feature[]|\Google\Protobuf\Internal\RepeatedField + \Google\Protobuf\Timestamp - - Requested features. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + + The time when the batch request was submitted to the server. + Generated from protobuf field <code>.google.protobuf.Timestamp submit_time = 2;</code> + variable="var" type="\Google\Protobuf\Timestamp"/> - - getImageContext - \Google\Cloud\Vision\V1\AnnotateImageRequest::getImageContext() + + getEndTime + \Google\Cloud\Vision\V1\BatchOperationMetadata::getEndTime() - - Additional context that may accompany the image. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + The time when the batch request is finished and +[google.longrunning.Operation.done][google.longrunning.Operation.done] is +set to true. + Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 3;</code> + type="\Google\Protobuf\Timestamp|null"/> - - hasImageContext - \Google\Cloud\Vision\V1\AnnotateImageRequest::hasImageContext() + + hasEndTime + \Google\Cloud\Vision\V1\BatchOperationMetadata::hasEndTime() - + - - clearImageContext - \Google\Cloud\Vision\V1\AnnotateImageRequest::clearImageContext() + + clearEndTime + \Google\Cloud\Vision\V1\BatchOperationMetadata::clearEndTime() - + - - setImageContext - \Google\Cloud\Vision\V1\AnnotateImageRequest::setImageContext() + + setEndTime + \Google\Cloud\Vision\V1\BatchOperationMetadata::setEndTime() - + var - \Google\Cloud\Vision\V1\ImageContext + \Google\Protobuf\Timestamp - - Additional context that may accompany the image. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + The time when the batch request is finished and +[google.longrunning.Operation.done][google.longrunning.Operation.done] is +set to true. + Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 3;</code> + variable="var" type="\Google\Protobuf\Timestamp"/> - + @@ -6119,285 +4710,326 @@ image, with user-requested features, and with context information. - + - - AnnotateImageResponse - \Google\Cloud\Vision\V1\AnnotateImageResponse - - Response to an image annotation request. - Generated from protobuf message <code>google.cloud.vision.v1.AnnotateImageResponse</code> + + + BlockType + \Google\Cloud\Vision\V1\Block\BlockType + + Type of a block (text, image etc) as identified by OCR. + Protobuf type <code>google.cloud.vision.v1.Block.BlockType</code> - \Google\Protobuf\Internal\Message - - - face_annotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::$face_annotations - - - If present, face detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation face_annotations = 1;</code> + + + UNKNOWN + \Google\Cloud\Vision\V1\Block\BlockType::UNKNOWN + 0 + + Unknown block type. + Generated from protobuf enum <code>UNKNOWN = 0;</code> - + - - landmark_annotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::$landmark_annotations - - - If present, landmark detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation landmark_annotations = 2;</code> + + TEXT + \Google\Cloud\Vision\V1\Block\BlockType::TEXT + 1 + + Regular text block. + Generated from protobuf enum <code>TEXT = 1;</code> - + - - logo_annotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::$logo_annotations - - - If present, logo detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation logo_annotations = 3;</code> + + TABLE + \Google\Cloud\Vision\V1\Block\BlockType::TABLE + 2 + + Table block. + Generated from protobuf enum <code>TABLE = 2;</code> - + - - label_annotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::$label_annotations - - - If present, label detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation label_annotations = 4;</code> + + PICTURE + \Google\Cloud\Vision\V1\Block\BlockType::PICTURE + 3 + + Image block. + Generated from protobuf enum <code>PICTURE = 3;</code> - + - - localized_object_annotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::$localized_object_annotations - - - If present, localized object detection has completed successfully. - This will be sorted descending by confidence score. + + RULER + \Google\Cloud\Vision\V1\Block\BlockType::RULER + 4 + + Horizontal/vertical line box. + Generated from protobuf enum <code>RULER = 4;</code> + -Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocalizedObjectAnnotation localized_object_annotations = 22;</code> + + + + BARCODE + \Google\Cloud\Vision\V1\Block\BlockType::BARCODE + 5 + + Barcode block. + Generated from protobuf enum <code>BARCODE = 5;</code> - + - - text_annotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::$text_annotations - - - If present, text (OCR) detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation text_annotations = 5;</code> + + + valueToName + \Google\Cloud\Vision\V1\Block\BlockType::$valueToName + [self::UNKNOWN => 'UNKNOWN', self::TEXT => 'TEXT', self::TABLE => 'TABLE', self::PICTURE => 'PICTURE', self::RULER => 'RULER', self::BARCODE => 'BARCODE'] + + + - - full_text_annotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::$full_text_annotation - null - - If present, text (OCR) detection or document (OCR) text detection has -completed successfully. - This annotation provides the structural hierarchy for the OCR detected -text. + + + name + \Google\Cloud\Vision\V1\Block\BlockType::name() + + + value + + mixed + -Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation full_text_annotation = 12;</code> + + + - + - - safe_search_annotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::$safe_search_annotation - null - - If present, safe-search annotation has completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.SafeSearchAnnotation safe_search_annotation = 6;</code> + + value + \Google\Cloud\Vision\V1\Block\BlockType::value() + + + name + + mixed + + + + + - + - - image_properties_annotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::$image_properties_annotation - null - - If present, image properties were extracted successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageProperties image_properties_annotation = 8;</code> - + + + + + + + + + + + + - - - crop_hints_annotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::$crop_hints_annotation + + + + + + + + + + Block + \Google\Cloud\Vision\V1\Block + + Logical element on the page. + Generated from protobuf message <code>google.cloud.vision.v1.Block</code> + + + + \Google\Protobuf\Internal\Message + + + + property + \Google\Cloud\Vision\V1\Block::$property null - - If present, crop hints have completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsAnnotation crop_hints_annotation = 11;</code> + + Additional information detected for the block. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - web_detection - \Google\Cloud\Vision\V1\AnnotateImageResponse::$web_detection + + bounding_box + \Google\Cloud\Vision\V1\Block::$bounding_box null - - If present, web detection has completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.WebDetection web_detection = 13;</code> + + The bounding box for the block. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: +* when the text is horizontal it might look like: + 0----1 + | | + 3----2 +* when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> - - product_search_results - \Google\Cloud\Vision\V1\AnnotateImageResponse::$product_search_results - null - - If present, product search has completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchResults product_search_results = 14;</code> + + paragraphs + \Google\Cloud\Vision\V1\Block::$paragraphs + + + List of paragraphs in this block (if this blocks is of type text). + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;</code> - - error - \Google\Cloud\Vision\V1\AnnotateImageResponse::$error - null - - If set, represents the error message for the operation. - Note that filled-in image annotations are guaranteed to be -correct, even when `error` is set. - -Generated from protobuf field <code>.google.rpc.Status error = 9;</code> + + block_type + \Google\Cloud\Vision\V1\Block::$block_type + 0 + + Detected block type (text, image etc) for this block. + Generated from protobuf field <code>.google.cloud.vision.v1.Block.BlockType block_type = 4;</code> - - context - \Google\Cloud\Vision\V1\AnnotateImageResponse::$context - null - - If present, contextual information is needed to understand where this image -comes from. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageAnnotationContext context = 21;</code> + + confidence + \Google\Cloud\Vision\V1\Block::$confidence + 0.0 + + Confidence of the OCR results on the block. Range [0, 1]. + Generated from protobuf field <code>float confidence = 5;</code> - + __construct - \Google\Cloud\Vision\V1\AnnotateImageResponse::__construct() + \Google\Cloud\Vision\V1\Block::__construct() - + data - NULL + null array - + Constructor. - - getFaceAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::getFaceAnnotations() + + getProperty + \Google\Cloud\Vision\V1\Block::getProperty() - - If present, face detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation face_annotations = 1;</code> + + Additional information detected for the block. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + type="\Google\Cloud\Vision\V1\TextAnnotation\TextProperty|null"/> - - setFaceAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::setFaceAnnotations() + + hasProperty + \Google\Cloud\Vision\V1\Block::hasProperty() - - var - - \Google\Cloud\Vision\V1\FaceAnnotation[]|\Google\Protobuf\Internal\RepeatedField - - - - If present, face detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation face_annotations = 1;</code> - - - + + + + - - getLandmarkAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::getLandmarkAnnotations() + + clearProperty + \Google\Cloud\Vision\V1\Block::clearProperty() - - If present, landmark detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation landmark_annotations = 2;</code> - - + + + + - - setLandmarkAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::setLandmarkAnnotations() + + setProperty + \Google\Cloud\Vision\V1\Block::setProperty() - + var - \Google\Cloud\Vision\V1\EntityAnnotation[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty - - If present, landmark detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation landmark_annotations = 2;</code> + + Additional information detected for the block. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\TextAnnotation\TextProperty"/> - - getLogoAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::getLogoAnnotations() + + getBoundingBox + \Google\Cloud\Vision\V1\Block::getBoundingBox() - - If present, logo detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation logo_annotations = 3;</code> + + The bounding box for the block. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: +* when the text is horizontal it might look like: + 0----1 + | | + 3----2 +* when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + type="\Google\Cloud\Vision\V1\BoundingPoly|null"/> - - setLogoAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::setLogoAnnotations() + + hasBoundingBox + \Google\Cloud\Vision\V1\Block::hasBoundingBox() - - var - - \Google\Cloud\Vision\V1\EntityAnnotation[]|\Google\Protobuf\Internal\RepeatedField + + + + + + + + + clearBoundingBox + \Google\Cloud\Vision\V1\Block::clearBoundingBox() + + + + + + + + + + setBoundingBox + \Google\Cloud\Vision\V1\Block::setBoundingBox() + + + var + + \Google\Cloud\Vision\V1\BoundingPoly - - If present, logo detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation logo_annotations = 3;</code> + + The bounding box for the block. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: +* when the text is horizontal it might look like: + 0----1 + | | + 3----2 +* when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> - - getLabelAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::getLabelAnnotations() + + getParagraphs + \Google\Cloud\Vision\V1\Block::getParagraphs() - - If present, label detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation label_annotations = 4;</code> + + List of paragraphs in this block (if this blocks is of type text). + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Paragraph>"/> - - setLabelAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::setLabelAnnotations() + + setParagraphs + \Google\Cloud\Vision\V1\Block::setParagraphs() - + var - \Google\Cloud\Vision\V1\EntityAnnotation[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\Paragraph[] - - If present, label detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation label_annotations = 4;</code> + + List of paragraphs in this block (if this blocks is of type text). + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;</code> + variable="var" type="\Google\Cloud\Vision\V1\Paragraph[]"/> - - getLocalizedObjectAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::getLocalizedObjectAnnotations() + + getBlockType + \Google\Cloud\Vision\V1\Block::getBlockType() - - If present, localized object detection has completed successfully. - This will be sorted descending by confidence score. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocalizedObjectAnnotation localized_object_annotations = 22;</code> + + Detected block type (text, image etc) for this block. + Generated from protobuf field <code>.google.cloud.vision.v1.Block.BlockType block_type = 4;</code> + type="int"/> - - setLocalizedObjectAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::setLocalizedObjectAnnotations() + + setBlockType + \Google\Cloud\Vision\V1\Block::setBlockType() - + var - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation[]|\Google\Protobuf\Internal\RepeatedField + int - - If present, localized object detection has completed successfully. - This will be sorted descending by confidence score. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocalizedObjectAnnotation localized_object_annotations = 22;</code> + + Detected block type (text, image etc) for this block. + Generated from protobuf field <code>.google.cloud.vision.v1.Block.BlockType block_type = 4;</code> + variable="var" type="int"/> - - getTextAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::getTextAnnotations() + + getConfidence + \Google\Cloud\Vision\V1\Block::getConfidence() - - If present, text (OCR) detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation text_annotations = 5;</code> + + Confidence of the OCR results on the block. Range [0, 1]. + Generated from protobuf field <code>float confidence = 5;</code> + type="float"/> - - setTextAnnotations - \Google\Cloud\Vision\V1\AnnotateImageResponse::setTextAnnotations() + + setConfidence + \Google\Cloud\Vision\V1\Block::setConfidence() - + var - \Google\Cloud\Vision\V1\EntityAnnotation[]|\Google\Protobuf\Internal\RepeatedField + float - - If present, text (OCR) detection has completed successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.EntityAnnotation text_annotations = 5;</code> + + Confidence of the OCR results on the block. Range [0, 1]. + Generated from protobuf field <code>float confidence = 5;</code> + variable="var" type="float"/> - - getFullTextAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::getFullTextAnnotation() - - - If present, text (OCR) detection or document (OCR) text detection has -completed successfully. - This annotation provides the structural hierarchy for the OCR detected -text. + + + + + + + + + + + + -Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation full_text_annotation = 12;</code> + + + + + + + + + + + BoundingPoly + \Google\Cloud\Vision\V1\BoundingPoly + + A bounding polygon for the detected image annotation. + Generated from protobuf message <code>google.cloud.vision.v1.BoundingPoly</code> + name="package" + description="Application" + /> - + \Google\Protobuf\Internal\Message + + + + vertices + \Google\Cloud\Vision\V1\BoundingPoly::$vertices + + + The bounding polygon vertices. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Vertex vertices = 1;</code> + - - hasFullTextAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::hasFullTextAnnotation() + + + + normalized_vertices + \Google\Cloud\Vision\V1\BoundingPoly::$normalized_vertices + + + The bounding polygon normalized vertices. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.NormalizedVertex normalized_vertices = 2;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\BoundingPoly::__construct() - - + + data + null + array + + + + Constructor. - + + - - clearFullTextAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::clearFullTextAnnotation() + + getVertices + \Google\Cloud\Vision\V1\BoundingPoly::getVertices() - - - - + + The bounding polygon vertices. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Vertex vertices = 1;</code> + + - - setFullTextAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::setFullTextAnnotation() + + setVertices + \Google\Cloud\Vision\V1\BoundingPoly::setVertices() - + var - \Google\Cloud\Vision\V1\TextAnnotation + \Google\Cloud\Vision\V1\Vertex[] - - If present, text (OCR) detection or document (OCR) text detection has -completed successfully. - This annotation provides the structural hierarchy for the OCR detected -text. - -Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation full_text_annotation = 12;</code> + + The bounding polygon vertices. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Vertex vertices = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\Vertex[]"/> - - getSafeSearchAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::getSafeSearchAnnotation() + + getNormalizedVertices + \Google\Cloud\Vision\V1\BoundingPoly::getNormalizedVertices() - - If present, safe-search annotation has completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.SafeSearchAnnotation safe_search_annotation = 6;</code> + + The bounding polygon normalized vertices. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.NormalizedVertex normalized_vertices = 2;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\NormalizedVertex>"/> - - hasSafeSearchAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::hasSafeSearchAnnotation() - - - - - - - - - - clearSafeSearchAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::clearSafeSearchAnnotation() - - - - - - - - - - setSafeSearchAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::setSafeSearchAnnotation() + + setNormalizedVertices + \Google\Cloud\Vision\V1\BoundingPoly::setNormalizedVertices() - + var - \Google\Cloud\Vision\V1\SafeSearchAnnotation + \Google\Cloud\Vision\V1\NormalizedVertex[] - - If present, safe-search annotation has completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.SafeSearchAnnotation safe_search_annotation = 6;</code> + + The bounding polygon normalized vertices. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.NormalizedVertex normalized_vertices = 2;</code> + variable="var" type="\Google\Cloud\Vision\V1\NormalizedVertex[]"/> - - getImagePropertiesAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::getImagePropertiesAnnotation() - - - If present, image properties were extracted successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageProperties image_properties_annotation = 8;</code> + + + + + + + + + + + + + + + + + + + + + + + ImageAnnotatorClient + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient + + Service Description: Service that performs Google Cloud Vision API detection tasks over client +images, such as face, landmark, logo, label, and text detection. The +ImageAnnotator service returns detected entities from the images. + This class provides the ability to make remote calls to the backing service through method +calls that map to API methods. + +Many parameters require resource names to be formatted in a particular way. To +assist with these names, this class includes a format method for each type of +name, and additionally a parseName method to extract the individual identifiers +contained within formatted names that are returned by the API. + + method_name="asyncBatchAnnotateFilesAsync" /> + + + + - + + + + SERVICE_NAME + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::SERVICE_NAME + 'google.cloud.vision.v1.ImageAnnotator' + + The name of the service. + + - - hasImagePropertiesAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::hasImagePropertiesAnnotation() - - - + + + + SERVICE_ADDRESS + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::SERVICE_ADDRESS + 'vision.googleapis.com' + + The default address of the service. - + + - + - - clearImagePropertiesAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::clearImagePropertiesAnnotation() - - - + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::SERVICE_ADDRESS_TEMPLATE + 'vision.UNIVERSE_DOMAIN' + + The address template of the service. - + - + - - setImagePropertiesAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::setImagePropertiesAnnotation() - - - var - - \Google\Cloud\Vision\V1\ImageProperties - + + DEFAULT_SERVICE_PORT + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::DEFAULT_SERVICE_PORT + 443 + + The default port of the service. + + - - If present, image properties were extracted successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageProperties image_properties_annotation = 8;</code> - - - + - + + CODEGEN_NAME + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::CODEGEN_NAME + 'gapic' + + The name of the code generator, to be included in the agent header. + + - - getCropHintsAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::getCropHintsAnnotation() - - - If present, crop hints have completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsAnnotation crop_hints_annotation = 11;</code> - - + - + + + serviceScopes + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::$serviceScopes + ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] + + The default scopes required by the service. + + - - hasCropHintsAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::hasCropHintsAnnotation() - - + + + + operationsClient + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::$operationsClient + + - + - + - - clearCropHintsAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::clearCropHintsAnnotation() + + + getClientDefaults + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::getClientDefaults() - + - - setCropHintsAnnotation - \Google\Cloud\Vision\V1\AnnotateImageResponse::setCropHintsAnnotation() + + getOperationsClient + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::getOperationsClient() - - var + + Return an OperationsClient object with the same endpoint as $this. + + + + + + + + resumeOperation + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::resumeOperation() + + + operationName - \Google\Cloud\Vision\V1\CropHintsAnnotation + string - - If present, crop hints have completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsAnnotation crop_hints_annotation = 11;</code> + + methodName + null + string + + + + Resume an existing long running operation that was previously started by a long +running API method. If $methodName is not provided, or does not match a long +running API method, then the operation can still be resumed, but the +OperationResponse object will not deserialize the final response. + + description="The name of the long running operation" + variable="operationName" type="string"/> + + type="\Google\ApiCore\OperationResponse"/> - - getWebDetection - \Google\Cloud\Vision\V1\AnnotateImageResponse::getWebDetection() + + createOperationsClient + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::createOperationsClient() - - If present, web detection has completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.WebDetection web_detection = 13;</code> + + options + + array + + + + Create the default operation client for the service. + + + type="\Google\LongRunning\Client\OperationsClient"/> - - hasWebDetection - \Google\Cloud\Vision\V1\AnnotateImageResponse::hasWebDetection() + + productSetName + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::productSetName() - - - - + + project + + string + - + + location + + string + - - clearWebDetection - \Google\Cloud\Vision\V1\AnnotateImageResponse::clearWebDetection() - - - + + productSet + + string + + + + Formats a string containing the fully-qualified path to represent a product_set +resource. - + + + + + - - setWebDetection - \Google\Cloud\Vision\V1\AnnotateImageResponse::setWebDetection() + + parseName + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::parseName() - - var + + formattedName - \Google\Cloud\Vision\V1\WebDetection + string - - If present, web detection has completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.WebDetection web_detection = 13;</code> + + template + null + ?string + + + + Parses a formatted name string and returns an associative array of the components in the name. + The following name formats are supported: +Template: Pattern +- productSet: projects/{project}/locations/{location}/productSets/{product_set} + +The optional $template argument can be supplied to specify a particular pattern, +and must match one of the templates listed above. If no $template argument is +provided, or if the $template argument does not match one of the templates +listed, then parseName will check each of the supported templates, and return +the first match. + description="The formatted name string" + variable="formattedName" type="string"/> + + description="An associative array from name component IDs to component values." + type="array"/> + - - getProductSearchResults - \Google\Cloud\Vision\V1\AnnotateImageResponse::getProductSearchResults() + + __construct + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::__construct() - - If present, product search has completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchResults product_search_results = 14;</code> + + options + [] + array|\Google\ApiCore\Options\ClientOptions + + + + Constructor. + + + type="\Google\ApiCore\ValidationException"/> - - hasProductSearchResults - \Google\Cloud\Vision\V1\AnnotateImageResponse::hasProductSearchResults() + + __call + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::__call() - - - - + + method + + mixed + - + + args + + mixed + - - clearProductSearchResults - \Google\Cloud\Vision\V1\AnnotateImageResponse::clearProductSearchResults() - - - + + Handles execution of the async variants for each documented method. - + - - setProductSearchResults - \Google\Cloud\Vision\V1\AnnotateImageResponse::setProductSearchResults() + + asyncBatchAnnotateFiles + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateFiles() - - var + + request - \Google\Cloud\Vision\V1\ProductSearchResults + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest - - If present, product search has completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchResults product_search_results = 14;</code> + + callOptions + [] + array + + + + Run asynchronous image detection and annotation for a list of generic +files, such as PDF files, which may contain multiple pages and multiple +images per page. Progress and results can be retrieved through the +`google.longrunning.Operations` interface. + `Operation.metadata` contains `OperationMetadata` (metadata). +`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateFilesAsync()} +. + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest"/> + + type="\Google\ApiCore\OperationResponse<\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse>"/> + - - getError - \Google\Cloud\Vision\V1\AnnotateImageResponse::getError() + + asyncBatchAnnotateImages + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImages() - - If set, represents the error message for the operation. - Note that filled-in image annotations are guaranteed to be -correct, even when `error` is set. + + request + + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest + -Generated from protobuf field <code>.google.rpc.Status error = 9;</code> + + callOptions + [] + array + + + + Run asynchronous image detection and annotation for a list of images. + Progress and results can be retrieved through the +`google.longrunning.Operations` interface. +`Operation.metadata` contains `OperationMetadata` (metadata). +`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + +This service will write image annotation outputs to json files in customer +GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + +The async variant is +{@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImagesAsync()} . + + + + type="\Google\ApiCore\OperationResponse<\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse>"/> + - - hasError - \Google\Cloud\Vision\V1\AnnotateImageResponse::hasError() + + batchAnnotateFiles + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFiles() - - - - + + request + + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest + - + + callOptions + [] + array + - - clearError - \Google\Cloud\Vision\V1\AnnotateImageResponse::clearError() - - - - - + + Service that performs image detection and annotation for a batch of files. + Now only "application/pdf", "image/tiff" and "image/gif" are supported. + +This service will extract at most 5 (customers can specify which 5 in +AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each +file provided and perform detection and annotation for each image +extracted. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFilesAsync()} . + + + + + + - - setError - \Google\Cloud\Vision\V1\AnnotateImageResponse::setError() + + batchAnnotateImages + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImages() - - var + + request - \Google\Rpc\Status + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest - - If set, represents the error message for the operation. - Note that filled-in image annotations are guaranteed to be -correct, even when `error` is set. + + callOptions + [] + array + -Generated from protobuf field <code>.google.rpc.Status error = 9;</code> + + Run image detection and annotation for a batch of images. + The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImagesAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest"/> + + type="\Google\Cloud\Vision\V1\BatchAnnotateImagesResponse"/> + - - getContext - \Google\Cloud\Vision\V1\AnnotateImageResponse::getContext() + + asyncBatchAnnotateFilesAsync + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateFilesAsync() - - If present, contextual information is needed to understand where this image -comes from. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageAnnotationContext context = 21;</code> + + request + + \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest + + + + optionalArgs + = '[]' + array + + + + + - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\OperationResponse>"/> + - - hasContext - \Google\Cloud\Vision\V1\AnnotateImageResponse::hasContext() + + asyncBatchAnnotateImagesAsync + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImagesAsync() - + + request + + \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest + + + + optionalArgs + = '[]' + array + + + - + + - - clearContext - \Google\Cloud\Vision\V1\AnnotateImageResponse::clearContext() + + batchAnnotateFilesAsync + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFilesAsync() - + + request + + \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest + + + + optionalArgs + = '[]' + array + + + - + + - - setContext - \Google\Cloud\Vision\V1\AnnotateImageResponse::setContext() + + batchAnnotateImagesAsync + \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImagesAsync() - - var + + request - \Google\Cloud\Vision\V1\ImageAnnotationContext + \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest - - If present, contextual information is needed to understand where this image -comes from. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageAnnotationContext context = 21;</code> + + optionalArgs + = '[]' + array + + + + + - - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\BatchAnnotateImagesResponse>"/> + - + - + @@ -7100,1642 +6111,2036 @@ comes from. - + - - AsyncAnnotateFileRequest - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest - - An offline file annotation request. - Generated from protobuf message <code>google.cloud.vision.v1.AsyncAnnotateFileRequest</code> + + + ProductSearchClient + \Google\Cloud\Vision\V1\Client\ProductSearchClient + + Service Description: Manages Products and ProductSets of reference images for use in product +search. It uses the following resource model: + - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet] +resources, named `projects/&#42;/locations/&#42;/productSets/*`, which acts as a way +to put different products into groups to limit identification. + +In parallel, + +- The API has a collection of [Product][google.cloud.vision.v1.Product] +resources, named +`projects/&#42;/locations/&#42;/products/*` + +- Each [Product][google.cloud.vision.v1.Product] has a collection of +[ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named +`projects/&#42;/locations/&#42;/products/&#42;/referenceImages/*` + +This class provides the ability to make remote calls to the backing service through method +calls that map to API methods. + +Many parameters require resource names to be formatted in a particular way. To +assist with these names, this class includes a format method for each type of +name, and additionally a parseName method to extract the individual identifiers +contained within formatted names that are returned by the API. + + + + + + + + + + + + + + + + + + + - \Google\Protobuf\Internal\Message - - - input_config - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::$input_config - null - - Required. Information about the input file. - Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + + + SERVICE_NAME + \Google\Cloud\Vision\V1\Client\ProductSearchClient::SERVICE_NAME + 'google.cloud.vision.v1.ProductSearch' + + The name of the service. + - + - - features - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::$features - - - Required. Requested features. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + + SERVICE_ADDRESS + \Google\Cloud\Vision\V1\Client\ProductSearchClient::SERVICE_ADDRESS + 'vision.googleapis.com' + + The default address of the service. + + + + + + + + SERVICE_ADDRESS_TEMPLATE + \Google\Cloud\Vision\V1\Client\ProductSearchClient::SERVICE_ADDRESS_TEMPLATE + 'vision.UNIVERSE_DOMAIN' + + The address template of the service. + - + - - image_context - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::$image_context - null - - Additional context that may accompany the image(s) in the file. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + DEFAULT_SERVICE_PORT + \Google\Cloud\Vision\V1\Client\ProductSearchClient::DEFAULT_SERVICE_PORT + 443 + + The default port of the service. + - + - - output_config - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::$output_config - null - - Required. The desired output location and metadata (e.g. format). - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 4;</code> + + CODEGEN_NAME + \Google\Cloud\Vision\V1\Client\ProductSearchClient::CODEGEN_NAME + 'gapic' + + The name of the code generator, to be included in the agent header. + - + - - __construct - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::__construct() - - - data - NULL - array - - - - Constructor. + + serviceScopes + \Google\Cloud\Vision\V1\Client\ProductSearchClient::$serviceScopes + ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] + + The default scopes required by the service. - - + - + - - getInputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::getInputConfig() - - - Required. Information about the input file. - Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> - - + + operationsClient + \Google\Cloud\Vision\V1\Client\ProductSearchClient::$operationsClient + + + + + - + - - hasInputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::hasInputConfig() + + + getClientDefaults + \Google\Cloud\Vision\V1\Client\ProductSearchClient::getClientDefaults() - + - - clearInputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::clearInputConfig() + + getOperationsClient + \Google\Cloud\Vision\V1\Client\ProductSearchClient::getOperationsClient() - - + + Return an OperationsClient object with the same endpoint as $this. - + + - - setInputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::setInputConfig() + + resumeOperation + \Google\Cloud\Vision\V1\Client\ProductSearchClient::resumeOperation() - - var + + operationName - \Google\Cloud\Vision\V1\InputConfig + string - - Required. Information about the input file. - Generated from protobuf field <code>.google.cloud.vision.v1.InputConfig input_config = 1;</code> + + methodName + null + string + + + + Resume an existing long running operation that was previously started by a long +running API method. If $methodName is not provided, or does not match a long +running API method, then the operation can still be resumed, but the +OperationResponse object will not deserialize the final response. + + description="The name of the long running operation" + variable="operationName" type="string"/> + + type="\Google\ApiCore\OperationResponse"/> - - getFeatures - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::getFeatures() + + createOperationsClient + \Google\Cloud\Vision\V1\Client\ProductSearchClient::createOperationsClient() - - Required. Requested features. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + + options + + array + + + + Create the default operation client for the service. + + + type="\Google\LongRunning\Client\OperationsClient"/> - - setFeatures - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::setFeatures() + + locationName + \Google\Cloud\Vision\V1\Client\ProductSearchClient::locationName() - - var + + project + + string + + + + location - \Google\Cloud\Vision\V1\Feature[]|\Google\Protobuf\Internal\RepeatedField + string - - Required. Requested features. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Feature features = 2;</code> + + Formats a string containing the fully-qualified path to represent a location +resource. + - + - - - - - - getImageContext - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::getImageContext() - - - Additional context that may accompany the image(s) in the file. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> - + + description="The formatted location resource." + type="string"/> - - hasImageContext - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::hasImageContext() - - - - - - - - - - clearImageContext - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::clearImageContext() + + productName + \Google\Cloud\Vision\V1\Client\ProductSearchClient::productName() - - - - + + project + + string + - + + location + + string + - - setImageContext - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::setImageContext() - - - var + + product - \Google\Cloud\Vision\V1\ImageContext + string - - Additional context that may accompany the image(s) in the file. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageContext image_context = 3;</code> + + Formats a string containing the fully-qualified path to represent a product +resource. + + variable="project" type="string"/> + + + description="The formatted product resource." + type="string"/> - - getOutputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::getOutputConfig() + + productSetName + \Google\Cloud\Vision\V1\Client\ProductSearchClient::productSetName() - - Required. The desired output location and metadata (e.g. format). - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 4;</code> + + project + + string + + + + location + + string + + + + productSet + + string + + + + Formats a string containing the fully-qualified path to represent a product_set +resource. + + variable="project" type="string"/> + + + - - hasOutputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::hasOutputConfig() + + referenceImageName + \Google\Cloud\Vision\V1\Client\ProductSearchClient::referenceImageName() - - - - - - + + project + + string + - - clearOutputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::clearOutputConfig() - - - - - + + location + + string + - + + product + + string + - - setOutputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::setOutputConfig() - - - var + + referenceImage - \Google\Cloud\Vision\V1\OutputConfig + string - - Required. The desired output location and metadata (e.g. format). - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 4;</code> + + Formats a string containing the fully-qualified path to represent a +reference_image resource. + + variable="project" type="string"/> + + + + description="The formatted reference_image resource." + type="string"/> - - - - - - - - - - - - + + parseName + \Google\Cloud\Vision\V1\Client\ProductSearchClient::parseName() + + + formattedName + + string + + + template + null + ?string + - - - + + Parses a formatted name string and returns an associative array of the components in the name. + The following name formats are supported: +Template: Pattern +- location: projects/{project}/locations/{location} +- product: projects/{project}/locations/{location}/products/{product} +- productSet: projects/{project}/locations/{location}/productSets/{product_set} +- referenceImage: projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image} - - - - - AsyncAnnotateFileResponse - \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse - - The response for a single offline file annotation request. - Generated from protobuf message <code>google.cloud.vision.v1.AsyncAnnotateFileResponse</code> +The optional $template argument can be supplied to specify a particular pattern, +and must match one of the templates listed above. If no $template argument is +provided, or if the $template argument does not match one of the templates +listed, then parseName will check each of the supported templates, and return +the first match. + name="param" + description="The formatted name string" + variable="formattedName" type="string"/> + + + - \Google\Protobuf\Internal\Message - - - - output_config - \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::$output_config - null - - The output location and metadata from AsyncAnnotateFileRequest. - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> - - - + - - + __construct - \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::__construct() + \Google\Cloud\Vision\V1\Client\ProductSearchClient::__construct() - - data - NULL - array + + options + [] + array|\Google\ApiCore\Options\ClientOptions - + Constructor. + description="{ Optional. Options for configuring the service API wrapper. @type string $apiEndpoint The address of the API remote host. May optionally include the port, formatted as "<uri>:<port>". Default 'vision.googleapis.com:443'. @type FetchAuthTokenInterface|CredentialsWrapper $credentials This option should only be used with a pre-constructed {@see \Google\Auth\FetchAuthTokenInterface} or {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important**: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly ``` use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Vision\V1\ProductSearchClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new ProductSearchClient(['credentials' => $creds]); ``` {@see https://cloud.google.com/docs/authentication/external/externally-sourced-credentials} @type array $credentialsConfig Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see {@see \Google\ApiCore\CredentialsWrapper::build()} . @type bool $disableRetries Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`. @type string|array $clientConfig 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. @type string|TransportInterface $transport 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 {@see \Google\ApiCore\Transport\TransportInterface} object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored. @type array $transportConfig 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 {@see \Google\ApiCore\Transport\GrpcTransport::build()} and {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the supported options. @type callable $clientCertSource 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. @type false|LoggerInterface $logger A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag @type string $universeDomain The service domain for the client. Defaults to 'googleapis.com'. }" + variable="options" type="array|\Google\ApiCore\Options\ClientOptions"/> + - - getOutputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::getOutputConfig() + + __call + \Google\Cloud\Vision\V1\Client\ProductSearchClient::__call() - - The output location and metadata from AsyncAnnotateFileRequest. - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> - - + + method + + mixed + - + + args + + mixed + - - hasOutputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::hasOutputConfig() - - - + + Handles execution of the async variants for each documented method. - + - - clearOutputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::clearOutputConfig() + + addProductToProductSet + \Google\Cloud\Vision\V1\Client\ProductSearchClient::addProductToProductSet() - - - - + + request + + \Google\Cloud\Vision\V1\AddProductToProductSetRequest + + + + callOptions + [] + array + + + + Adds a Product to the specified ProductSet. If the Product is already +present, no change is made. + One Product can be added to at most 100 ProductSets. + +Possible errors: + +* Returns NOT_FOUND if the Product or the ProductSet doesn't exist. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::addProductToProductSetAsync()} . + + + + + - - setOutputConfig - \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse::setOutputConfig() + + createProduct + \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProduct() - - var + + request - \Google\Cloud\Vision\V1\OutputConfig + \Google\Cloud\Vision\V1\CreateProductRequest - - The output location and metadata from AsyncAnnotateFileRequest. - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> + + callOptions + [] + array + + + + Creates and returns a new product resource. + Possible errors: + +* Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 +characters. +* Returns INVALID_ARGUMENT if description is longer than 4096 characters. +* Returns INVALID_ARGUMENT if product_category is missing or invalid. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\CreateProductRequest"/> + + type="\Google\Cloud\Vision\V1\Product"/> + - - - - - - - - - - - - + + createProductSet + \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductSet() + + + request + + \Google\Cloud\Vision\V1\CreateProductSetRequest + + + callOptions + [] + array + - - - + + Creates and returns a new ProductSet resource. + Possible errors: - - - - - AsyncBatchAnnotateFilesRequest - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest - - Multiple async file annotation requests are batched into a single service -call. - Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateFilesRequest</code> - + + + + + - \Google\Protobuf\Internal\Message - - - - requests - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::$requests - - - Required. Individual async file annotation requests for this batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - parent - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::$parent - '' - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. + -Generated from protobuf field <code>string parent = 4;</code> - + + createReferenceImage + \Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImage() + + + request + + \Google\Cloud\Vision\V1\CreateReferenceImageRequest + - + + callOptions + [] + array + - - labels - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::$labels - - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. + + Creates and returns a new ReferenceImage resource. + The `bounding_poly` field is optional. If `bounding_poly` is not specified, +the system will try to detect regions of interest in the image that are +compatible with the product_category on the parent product. If it is +specified, detection is ALWAYS skipped. The system converts polygons into +non-rotated rectangles. -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> - +Note that the pipeline will resize the image if the image resolution is too +large to process (above 50MP). - +Possible errors: - - - build - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::build() - - - requests - - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[] - +* Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 +characters. +* Returns INVALID_ARGUMENT if the product does not exist. +* Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing +compatible with the parent product's product_category is detected. +* Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. - - - +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImageAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\CreateReferenceImageRequest"/> + + type="\Google\Cloud\Vision\V1\ReferenceImage"/> + name="throws" + description="Thrown if the API call fails." + type="\Google\ApiCore\ApiException"/> - - __construct - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::__construct() + + deleteProduct + \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProduct() - - data - NULL + + request + + \Google\Cloud\Vision\V1\DeleteProductRequest + + + + callOptions + [] array - - Constructor. - + + Permanently deletes a product and its reference images. + Metadata of the product and all its images will be deleted right away, but +search queries against ProductSets containing the product may still work +until all related caches are refreshed. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\DeleteProductRequest"/> + + - - getRequests - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getRequests() + + deleteProductSet + \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSet() - - Required. Individual async file annotation requests for this batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + request + + \Google\Cloud\Vision\V1\DeleteProductSetRequest + + + + callOptions + [] + array + + + + Permanently deletes a ProductSet. Products and ReferenceImages in the +ProductSet are not deleted. + The actual image files are not deleted from Google Cloud Storage. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSetAsync()} . + name="example" + description="samples/V1/ProductSearchClient/delete_product_set.php" + /> + + + - - setRequests - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setRequests() + + deleteReferenceImage + \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImage() - - var + + request - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\DeleteReferenceImageRequest - - Required. Individual async file annotation requests for this batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + callOptions + [] + array + + + + Permanently deletes a reference image. + The image metadata will be deleted right away, but search queries +against ProductSets containing the image may still work until all related +caches are refreshed. + +The actual image files are not deleted from Google Cloud Storage. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImageAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\DeleteReferenceImageRequest"/> + + name="throws" + description="Thrown if the API call fails." + type="\Google\ApiCore\ApiException"/> - - getParent - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getParent() + + getProduct + \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProduct() - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. + + request + + \Google\Cloud\Vision\V1\GetProductRequest + -Generated from protobuf field <code>string parent = 4;</code> + + callOptions + [] + array + + + + Gets information associated with a Product. + Possible errors: + +* Returns NOT_FOUND if the Product does not exist. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductAsync()} . + + + + type="\Google\Cloud\Vision\V1\Product"/> + - - setParent - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setParent() + + getProductSet + \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSet() - - var + + request - string + \Google\Cloud\Vision\V1\GetProductSetRequest - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. + + callOptions + [] + array + -Generated from protobuf field <code>string parent = 4;</code> + + Gets information associated with a ProductSet. + Possible errors: + +* Returns NOT_FOUND if the ProductSet does not exist. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSetAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\GetProductSetRequest"/> + + type="\Google\Cloud\Vision\V1\ProductSet"/> + - - getLabels - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::getLabels() + + getReferenceImage + \Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImage() - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. + + request + + \Google\Cloud\Vision\V1\GetReferenceImageRequest + -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + callOptions + [] + array + + + + Gets information associated with a ReferenceImage. + Possible errors: + +* Returns NOT_FOUND if the specified image does not exist. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImageAsync()} . + + + + type="\Google\Cloud\Vision\V1\ReferenceImage"/> + - - setLabels - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setLabels() + + importProductSets + \Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSets() - - var + + request - array|\Google\Protobuf\Internal\MapField + \Google\Cloud\Vision\V1\ImportProductSetsRequest - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. + + callOptions + [] + array + -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + Asynchronous API that imports a list of reference images to specified +product sets based on a list of image information. + The [google.longrunning.Operation][google.longrunning.Operation] API can be +used to keep track of the progress and results of the request. +`Operation.metadata` contains `BatchOperationMetadata`. (progress) +`Operation.response` contains `ImportProductSetsResponse`. (results) + +The input source of this method is a csv file on Google Cloud Storage. +For the format of the csv file please see +[ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri]. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSetsAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\ImportProductSetsRequest"/> + + type="\Google\ApiCore\OperationResponse<\Google\Cloud\Vision\V1\ImportProductSetsResponse>"/> + - - - - - - - - - - - - + + listProductSets + \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSets() + + + request + + \Google\Cloud\Vision\V1\ListProductSetsRequest + + + callOptions + [] + array + - - - + + Lists ProductSets in an unspecified order. + Possible errors: - - - - - AsyncBatchAnnotateFilesResponse - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse - - Response to an async batch file annotation request. - Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse</code> +* Returns INVALID_ARGUMENT if page_size is greater than 100, or less +than 1. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSetsAsync()} . + + + + - \Google\Protobuf\Internal\Message - - - - responses - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse::$responses - - - The list of file annotation responses, one for each request in -AsyncBatchAnnotateFilesRequest. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileResponse responses = 1;</code> - - - + - - - __construct - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse::__construct() + + listProducts + \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProducts() - - data - NULL + + request + + \Google\Cloud\Vision\V1\ListProductsRequest + + + + callOptions + [] array - - Constructor. - - - + + Lists products in an unspecified order. + Possible errors: - +* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. - - getResponses - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse::getResponses() - - - The list of file annotation responses, one for each request in -AsyncBatchAnnotateFilesRequest. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileResponse responses = 1;</code> +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsAsync()} . + + + + type="\Google\ApiCore\PagedListResponse"/> + - - setResponses - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse::setResponses() + + listProductsInProductSet + \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSet() - - var + + request - \Google\Cloud\Vision\V1\AsyncAnnotateFileResponse[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest - - The list of file annotation responses, one for each request in -AsyncBatchAnnotateFilesRequest. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AsyncAnnotateFileResponse responses = 1;</code> + + callOptions + [] + array + + + + Lists the Products in a ProductSet, in an unspecified order. If the +ProductSet does not exist, the products field of the response will be +empty. + Possible errors: + +* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSetAsync()} +. + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\ListProductsInProductSetRequest"/> + + type="\Google\ApiCore\PagedListResponse"/> + - - - - - - - - - - - - - - - - - - - - - - - AsyncBatchAnnotateImagesRequest - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest - - Request for async image annotation for a list of images. - Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateImagesRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - requests - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::$requests - - - Required. Individual image annotation requests for this batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - output_config - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::$output_config - null - - Required. The desired output location and metadata (e.g. format). - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - parent - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::$parent - '' - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. - -Generated from protobuf field <code>string parent = 4;</code> - - - - - - labels - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::$labels - - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. - -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> - - - - - - - build - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::build() + + listReferenceImages + \Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImages() - - requests + + request - \Google\Cloud\Vision\V1\AnnotateImageRequest[] + \Google\Cloud\Vision\V1\ListReferenceImagesRequest - - outputConfig - - \Google\Cloud\Vision\V1\OutputConfig + + callOptions + [] + array - - - + + Lists reference images. + Possible errors: + +* Returns NOT_FOUND if the parent product does not exist. +* Returns INVALID_ARGUMENT if the page_size is greater than 100, or less +than 1. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImagesAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\ListReferenceImagesRequest"/> + description="{ Optional. @type RetrySettings|array $retrySettings Retry settings to use for this call. Can be a {@see \Google\ApiCore\RetrySettings} object, or an associative array of retry settings parameters. See the documentation on {@see \Google\ApiCore\RetrySettings} for example usage. }" + variable="callOptions" type="array"/> + type="\Google\ApiCore\PagedListResponse"/> + name="throws" + description="Thrown if the API call fails." + type="\Google\ApiCore\ApiException"/> - - __construct - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::__construct() + + purgeProducts + \Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProducts() - - data - NULL - array + + request + + \Google\Cloud\Vision\V1\PurgeProductsRequest - - Constructor. - - - + + callOptions + [] + array + - + + Asynchronous API to delete all Products in a ProductSet or all Products +that are in no ProductSet. + If a Product is a member of the specified ProductSet in addition to other +ProductSets, the Product will still be deleted. - - getRequests - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getRequests() - - - Required. Individual image annotation requests for this batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> +It is recommended to not delete the specified ProductSet until after this +operation has completed. It is also recommended to not add any of the +Products involved in the batch delete to a new ProductSet while this +operation is running because those Products may still end up deleted. + +It's not possible to undo the PurgeProducts operation. Therefore, it is +recommended to keep the csv files used in ImportProductSets (if that was +how you originally built the Product Set) before starting PurgeProducts, in +case you need to re-import the data after deletion. + +If the plan is to purge all of the Products from a ProductSet and then +re-use the empty ProductSet to re-import new Products into the empty +ProductSet, you must wait until the PurgeProducts operation has finished +for that ProductSet. + +The [google.longrunning.Operation][google.longrunning.Operation] API can be +used to keep track of the progress and results of the request. +`Operation.metadata` contains `BatchOperationMetadata`. (progress) + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProductsAsync()} . + + + + type="\Google\ApiCore\OperationResponse<null>"/> + - - setRequests - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setRequests() + + removeProductFromProductSet + \Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSet() - - var + + request - \Google\Cloud\Vision\V1\AnnotateImageRequest[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest - - Required. Individual image annotation requests for this batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + callOptions + [] + array + + + + Removes a Product from the specified ProductSet. + The async variant is +{@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSetAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest"/> + + name="throws" + description="Thrown if the API call fails." + type="\Google\ApiCore\ApiException"/> - - getOutputConfig - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getOutputConfig() + + updateProduct + \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProduct() - - Required. The desired output location and metadata (e.g. format). - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + request + + \Google\Cloud\Vision\V1\UpdateProductRequest + + + + callOptions + [] + array + + + + Makes changes to a Product resource. + Only the `display_name`, `description`, and `labels` fields can be updated +right now. + +If labels are updated, the change will not be reflected in queries until +the next index time. + +Possible errors: + +* Returns NOT_FOUND if the Product does not exist. +* Returns INVALID_ARGUMENT if display_name is present in update_mask but is +missing from the request or longer than 4096 characters. +* Returns INVALID_ARGUMENT if description is present in update_mask but is +longer than 4096 characters. +* Returns INVALID_ARGUMENT if product_category is present in update_mask. + +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductAsync()} . + + + + type="\Google\Cloud\Vision\V1\Product"/> + - - hasOutputConfig - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::hasOutputConfig() + + updateProductSet + \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSet() - - - - + + request + + \Google\Cloud\Vision\V1\UpdateProductSetRequest + - + + callOptions + [] + array + - - clearOutputConfig - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::clearOutputConfig() - - - - - + + Makes changes to a ProductSet resource. + Only display_name can be updated currently. - +Possible errors: - - setOutputConfig - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setOutputConfig() - - - var - - \Google\Cloud\Vision\V1\OutputConfig - +* Returns NOT_FOUND if the ProductSet does not exist. +* Returns INVALID_ARGUMENT if display_name is present in update_mask but +missing from the request or longer than 4096 characters. - - Required. The desired output location and metadata (e.g. format). - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> +The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSetAsync()} . + + description="A request to house fields associated with the call." + variable="request" type="\Google\Cloud\Vision\V1\UpdateProductSetRequest"/> + + type="\Google\Cloud\Vision\V1\ProductSet"/> + - - getParent - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getParent() + + addProductToProductSetAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::addProductToProductSetAsync() - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. + + request + + \Google\Cloud\Vision\V1\AddProductToProductSetRequest + -Generated from protobuf field <code>string parent = 4;</code> + + optionalArgs + = '[]' + array + + + + + - + type="\GuzzleHttp\Promise\PromiseInterface<void>"/> + - - setParent - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setParent() + + createProductAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductAsync() - - var + + request - string + \Google\Cloud\Vision\V1\CreateProductRequest - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. + + optionalArgs + = '[]' + array + -Generated from protobuf field <code>string parent = 4;</code> + + + - - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\Product>"/> + - - getLabels - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getLabels() + + createProductSetAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductSetAsync() - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. + + request + + \Google\Cloud\Vision\V1\CreateProductSetRequest + -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + optionalArgs + = '[]' + array + + + + + - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ProductSet>"/> + - - setLabels - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setLabels() + + createReferenceImageAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImageAsync() - - var + + request - array|\Google\Protobuf\Internal\MapField + \Google\Cloud\Vision\V1\CreateReferenceImageRequest - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. + + optionalArgs + = '[]' + array + -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + - - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ReferenceImage>"/> + - - - - - - - - + + deleteProductAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductAsync() + + + request + + \Google\Cloud\Vision\V1\DeleteProductRequest + + + + optionalArgs + = '[]' + array + + + + name="return" + description="" + type="\GuzzleHttp\Promise\PromiseInterface<void>"/> + - - - - - - - - - AsyncBatchAnnotateImagesResponse - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse - - Response to an async batch image annotation request. - Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateImagesResponse</code> - - - - \Google\Protobuf\Internal\Message - - - - output_config - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::$output_config - null - - The output location and metadata from AsyncBatchAnnotateImagesRequest. - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::__construct() + + deleteProductSetAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSetAsync() - - data - NULL + + request + + \Google\Cloud\Vision\V1\DeleteProductSetRequest + + + + optionalArgs + = '[]' array - - Constructor. + + - - - - - - getOutputConfig - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::getOutputConfig() - - - The output location and metadata from AsyncBatchAnnotateImagesRequest. - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> - - + type="\GuzzleHttp\Promise\PromiseInterface<void>"/> + - - hasOutputConfig - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::hasOutputConfig() + + deleteReferenceImageAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImageAsync() - - - - + + request + + \Google\Cloud\Vision\V1\DeleteReferenceImageRequest + - + + optionalArgs + = '[]' + array + - - clearOutputConfig - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::clearOutputConfig() - - + - + + - - setOutputConfig - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse::setOutputConfig() + + getProductAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductAsync() - - var + + request - \Google\Cloud\Vision\V1\OutputConfig + \Google\Cloud\Vision\V1\GetProductRequest - - The output location and metadata from AsyncBatchAnnotateImagesRequest. - Generated from protobuf field <code>.google.cloud.vision.v1.OutputConfig output_config = 1;</code> + + optionalArgs + = '[]' + array + + + + + - - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\Product>"/> + - - - - - - - - + + getProductSetAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSetAsync() + + + request + + \Google\Cloud\Vision\V1\GetProductSetRequest + + + + optionalArgs + = '[]' + array + + + + name="return" + description="" + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ProductSet>"/> + - - - - - - - - - BatchAnnotateFilesRequest - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest - - A list of requests to annotate files using the BatchAnnotateFiles API. - Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateFilesRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - requests - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::$requests - - - Required. The list of file annotation requests. Right now we support only -one AnnotateFileRequest in BatchAnnotateFilesRequest. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - parent - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::$parent - '' - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. - -Generated from protobuf field <code>string parent = 3;</code> - - - - - - labels - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::$labels - - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. - -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> - - - - - - - build - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::build() + + getReferenceImageAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImageAsync() - - requests + + request - \Google\Cloud\Vision\V1\AnnotateFileRequest[] + \Google\Cloud\Vision\V1\GetReferenceImageRequest - + + optionalArgs + = '[]' + array + + + - - - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ReferenceImage>"/> + - - __construct - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::__construct() + + importProductSetsAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSetsAsync() - - data - NULL + + request + + \Google\Cloud\Vision\V1\ImportProductSetsRequest + + + + optionalArgs + = '[]' array - - Constructor. + + - + name="return" + description="" + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\OperationResponse>"/> + - - getRequests - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getRequests() + + listProductSetsAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSetsAsync() - - Required. The list of file annotation requests. Right now we support only -one AnnotateFileRequest in BatchAnnotateFilesRequest. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + request + + \Google\Cloud\Vision\V1\ListProductSetsRequest + + + + optionalArgs + = '[]' + array + + + + + - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\PagedListResponse>"/> + - - setRequests - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setRequests() + + listProductsAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsAsync() - - var + + request - \Google\Cloud\Vision\V1\AnnotateFileRequest[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\ListProductsRequest - - Required. The list of file annotation requests. Right now we support only -one AnnotateFileRequest in BatchAnnotateFilesRequest. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + optionalArgs + = '[]' + array + + + + + - - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\PagedListResponse>"/> + - - getParent - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getParent() + + listProductsInProductSetAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSetAsync() - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. + + request + + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest + -Generated from protobuf field <code>string parent = 3;</code> + + optionalArgs + = '[]' + array + + + + + - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\PagedListResponse>"/> + - - setParent - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setParent() + + listReferenceImagesAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImagesAsync() - - var + + request - string + \Google\Cloud\Vision\V1\ListReferenceImagesRequest - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. + + optionalArgs + = '[]' + array + -Generated from protobuf field <code>string parent = 3;</code> + + + - + + + + + + purgeProductsAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProductsAsync() + + + request + + \Google\Cloud\Vision\V1\PurgeProductsRequest + + + + optionalArgs + = '[]' + array + + + + + + - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\ApiCore\OperationResponse>"/> + - - getLabels - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::getLabels() + + removeProductFromProductSetAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSetAsync() - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. + + request + + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest + -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + optionalArgs + = '[]' + array + + + + + - + type="\GuzzleHttp\Promise\PromiseInterface<void>"/> + - - setLabels - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setLabels() + + updateProductAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductAsync() - - var + + request - array|\Google\Protobuf\Internal\MapField + \Google\Cloud\Vision\V1\UpdateProductRequest - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. + + optionalArgs + = '[]' + array + -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + - + + + + + + updateProductSetAsync + \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSetAsync() + + + request + + \Google\Cloud\Vision\V1\UpdateProductSetRequest + + + + optionalArgs + = '[]' + array + + + + + + - + type="\GuzzleHttp\Promise\PromiseInterface<\Google\Cloud\Vision\V1\ProductSet>"/> + - + - + @@ -8753,12 +8158,14 @@ Generated from protobuf field <code>map<string, string> labels = 5 [ - - BatchAnnotateFilesResponse - \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse - - A list of file annotation responses. - Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateFilesResponse</code> + + + ColorInfo + \Google\Cloud\Vision\V1\ColorInfo + + Color information consists of RGB channels, score, and the fraction of +the image that the color occupies in the image. + Generated from protobuf message <code>google.cloud.vision.v1.ColorInfo</code> \Google\Protobuf\Internal\Message - - responses - \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse::$responses - + + color + \Google\Cloud\Vision\V1\ColorInfo::$color + null - The list of file annotation responses, each response corresponding to each -AnnotateFileRequest in BatchAnnotateFilesRequest. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileResponse responses = 1;</code> + RGB components of the color. + Generated from protobuf field <code>.google.type.Color color = 1;</code> + + + + + + score + \Google\Cloud\Vision\V1\ColorInfo::$score + 0.0 + + Image-specific score for this color. Value in range [0, 1]. + Generated from protobuf field <code>float score = 2;</code> + + + + + + pixel_fraction + \Google\Cloud\Vision\V1\ColorInfo::$pixel_fraction + 0.0 + + The fraction of pixels the color occupies in the image. + Value in range [0, 1]. + +Generated from protobuf field <code>float pixel_fraction = 3;</code> - + __construct - \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse::__construct() + \Google\Cloud\Vision\V1\ColorInfo::__construct() - + data - NULL + null array - + Constructor. - - getResponses - \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse::getResponses() + + getColor + \Google\Cloud\Vision\V1\ColorInfo::getColor() - - The list of file annotation responses, each response corresponding to each -AnnotateFileRequest in BatchAnnotateFilesRequest. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileResponse responses = 1;</code> + + RGB components of the color. + Generated from protobuf field <code>.google.type.Color color = 1;</code> + type="\Google\Type\Color|null"/> - - setResponses - \Google\Cloud\Vision\V1\BatchAnnotateFilesResponse::setResponses() + + hasColor + \Google\Cloud\Vision\V1\ColorInfo::hasColor() - + + + + + + + + + clearColor + \Google\Cloud\Vision\V1\ColorInfo::clearColor() + + + + + + + + + + setColor + \Google\Cloud\Vision\V1\ColorInfo::setColor() + + var - \Google\Cloud\Vision\V1\AnnotateFileResponse[]|\Google\Protobuf\Internal\RepeatedField + \Google\Type\Color - - The list of file annotation responses, each response corresponding to each -AnnotateFileRequest in BatchAnnotateFilesRequest. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateFileResponse responses = 1;</code> + + RGB components of the color. + Generated from protobuf field <code>.google.type.Color color = 1;</code> + variable="var" type="\Google\Type\Color"/> - - - - - + + getScore + \Google\Cloud\Vision\V1\ColorInfo::getScore() + + + Image-specific score for this color. Value in range [0, 1]. + Generated from protobuf field <code>float score = 2;</code> + + + + + + + setScore + \Google\Cloud\Vision\V1\ColorInfo::setScore() + + + var + + float + + + + Image-specific score for this color. Value in range [0, 1]. + Generated from protobuf field <code>float score = 2;</code> + + + + + + + + getPixelFraction + \Google\Cloud\Vision\V1\ColorInfo::getPixelFraction() + + + The fraction of pixels the color occupies in the image. + Value in range [0, 1]. + +Generated from protobuf field <code>float pixel_fraction = 3;</code> + + + + + + + setPixelFraction + \Google\Cloud\Vision\V1\ColorInfo::setPixelFraction() + + + var + + float + + + + The fraction of pixels the color occupies in the image. + Value in range [0, 1]. + +Generated from protobuf field <code>float pixel_fraction = 3;</code> + + + + + + + + + + + - + @@ -8868,12 +8402,13 @@ AnnotateFileRequest in BatchAnnotateFilesRequest. + - BatchAnnotateImagesRequest - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest + CreateProductRequest + \Google\Cloud\Vision\V1\CreateProductRequest - Multiple image annotation requests are batched into a single service call. - Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateImagesRequest</code> + Request message for the `CreateProduct` method. + Generated from protobuf message <code>google.cloud.vision.v1.CreateProductRequest</code> \Google\Protobuf\Internal\Message - - requests - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::$requests - - - Required. Individual image annotation requests for this batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - + parent - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::$parent + \Google\Cloud\Vision\V1\CreateProductRequest::$parent '' - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. + + Required. The project in which the Product should be created. + Format is +`projects/PROJECT_ID/locations/LOC_ID`. -Generated from protobuf field <code>string parent = 4;</code> +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - labels - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::$labels - - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. + + product + \Google\Cloud\Vision\V1\CreateProductRequest::$product + null + + Required. The product to create. + Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 2 [(.google.api.field_behavior) = REQUIRED];</code> + -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + + + product_id + \Google\Cloud\Vision\V1\CreateProductRequest::$product_id + '' + + A user-supplied resource id for this Product. If set, the server will +attempt to use this value as the resource id. If it is already in use, an +error is returned with code ALREADY_EXISTS. Must be at most 128 characters +long. It cannot contain the character `/`. + Generated from protobuf field <code>string product_id = 3;</code> - + build - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::build() + \Google\Cloud\Vision\V1\CreateProductRequest::build() - - requests + + parent - \Google\Cloud\Vision\V1\AnnotateImageRequest[] + string - + + product + + \Google\Cloud\Vision\V1\Product + + + + productId + + string + + + + description="Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. Please see {@see \Google\Cloud\Vision\V1\ProductSearchClient::locationName()} for help formatting this field." + variable="parent" type="string"/> + + + type="\Google\Cloud\Vision\V1\CreateProductRequest"/> - + __construct - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::__construct() + \Google\Cloud\Vision\V1\CreateProductRequest::__construct() - + data - NULL + null array - + Constructor. - - getRequests - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getRequests() + + getParent + \Google\Cloud\Vision\V1\CreateProductRequest::getParent() - - Required. Individual image annotation requests for this batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + Required. The project in which the Product should be created. + Format is +`projects/PROJECT_ID/locations/LOC_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + type="string"/> - - setRequests - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setRequests() + + setParent + \Google\Cloud\Vision\V1\CreateProductRequest::setParent() - + var - \Google\Cloud\Vision\V1\AnnotateImageRequest[]|\Google\Protobuf\Internal\RepeatedField + string - - Required. Individual image annotation requests for this batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageRequest requests = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + Required. The project in which the Product should be created. + Format is +`projects/PROJECT_ID/locations/LOC_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + variable="var" type="string"/> - - getParent - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getParent() + + getProduct + \Google\Cloud\Vision\V1\CreateProductRequest::getProduct() - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. - -Generated from protobuf field <code>string parent = 4;</code> - + Required. The product to create. + Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + type="\Google\Cloud\Vision\V1\Product|null"/> - - setParent - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setParent() + + hasProduct + \Google\Cloud\Vision\V1\CreateProductRequest::hasProduct() - + + + + + + + + + clearProduct + \Google\Cloud\Vision\V1\CreateProductRequest::clearProduct() + + + + + + + + + + setProduct + \Google\Cloud\Vision\V1\CreateProductRequest::setProduct() + + var - string + \Google\Cloud\Vision\V1\Product - - Optional. Target project and location to make a call. - Format: `projects/{project-id}/locations/{location-id}`. -If no parent is specified, a region will be chosen automatically. -Supported location-ids: - `us`: USA country only, - `asia`: East asia areas, like Japan, Taiwan, - `eu`: The European Union. -Example: `projects/project-A/locations/eu`. - -Generated from protobuf field <code>string parent = 4;</code> + + Required. The product to create. + Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 2 [(.google.api.field_behavior) = REQUIRED];</code> + variable="var" type="\Google\Cloud\Vision\V1\Product"/> - - getLabels - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::getLabels() + + getProductId + \Google\Cloud\Vision\V1\CreateProductRequest::getProductId() - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. - -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + A user-supplied resource id for this Product. If set, the server will +attempt to use this value as the resource id. If it is already in use, an +error is returned with code ALREADY_EXISTS. Must be at most 128 characters +long. It cannot contain the character `/`. + Generated from protobuf field <code>string product_id = 3;</code> + type="string"/> - - setLabels - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setLabels() + + setProductId + \Google\Cloud\Vision\V1\CreateProductRequest::setProductId() - + var - array|\Google\Protobuf\Internal\MapField + string - - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters -(Unicode codepoints), can only contain lowercase letters, numeric -characters, underscores and dashes. International characters are allowed. -Label values are optional. Label keys must start with a letter. - -Generated from protobuf field <code>map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];</code> + + A user-supplied resource id for this Product. If set, the server will +attempt to use this value as the resource id. If it is already in use, an +error is returned with code ALREADY_EXISTS. Must be at most 128 characters +long. It cannot contain the character `/`. + Generated from protobuf field <code>string product_id = 3;</code> + variable="var" type="string"/> - + @@ -9150,12 +8706,13 @@ Generated from protobuf field <code>map<string, string> labels = 5 [ + - BatchAnnotateImagesResponse - \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse + CreateProductSetRequest + \Google\Cloud\Vision\V1\CreateProductSetRequest - Response to a batch image annotation request. - Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateImagesResponse</code> + Request message for the `CreateProductSet` method. + Generated from protobuf message <code>google.cloud.vision.v1.CreateProductSetRequest</code> \Google\Protobuf\Internal\Message - - responses - \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse::$responses - - - Individual responses to image annotation requests within the batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 1;</code> + + parent + \Google\Cloud\Vision\V1\CreateProductSetRequest::$parent + '' + + Required. The project in which the ProductSet should be created. + Format is `projects/PROJECT_ID/locations/LOC_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + product_set + \Google\Cloud\Vision\V1\CreateProductSetRequest::$product_set + null + + Required. The ProductSet to create. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + + + + + product_set_id + \Google\Cloud\Vision\V1\CreateProductSetRequest::$product_set_id + '' + + A user-supplied resource id for this ProductSet. If set, the server will +attempt to use this value as the resource id. If it is already in use, an +error is returned with code ALREADY_EXISTS. Must be at most 128 characters +long. It cannot contain the character `/`. + Generated from protobuf field <code>string product_set_id = 3;</code> - + + build + \Google\Cloud\Vision\V1\CreateProductSetRequest::build() + + + parent + + string + + + + productSet + + \Google\Cloud\Vision\V1\ProductSet + + + + productSetId + + string + + + + + + + + + + + + + + + __construct - \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse::__construct() + \Google\Cloud\Vision\V1\CreateProductSetRequest::__construct() - + data - NULL + null array - + Constructor. - - getResponses - \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse::getResponses() + + getParent + \Google\Cloud\Vision\V1\CreateProductSetRequest::getParent() - - Individual responses to image annotation requests within the batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 1;</code> + + Required. The project in which the ProductSet should be created. + Format is `projects/PROJECT_ID/locations/LOC_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + type="string"/> - - setResponses - \Google\Cloud\Vision\V1\BatchAnnotateImagesResponse::setResponses() + + setParent + \Google\Cloud\Vision\V1\CreateProductSetRequest::setParent() - + var - \Google\Cloud\Vision\V1\AnnotateImageResponse[]|\Google\Protobuf\Internal\RepeatedField + string - - Individual responses to image annotation requests within the batch. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.AnnotateImageResponse responses = 1;</code> + + Required. The project in which the ProductSet should be created. + Format is `projects/PROJECT_ID/locations/LOC_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + variable="var" type="string"/> - - - - - - - - - - - - - - - - - - - - - - - State - \Google\Cloud\Vision\V1\BatchOperationMetadata\State - - Enumerates the possible states that the batch request can be in. - Protobuf type <code>google.cloud.vision.v1.BatchOperationMetadata.State</code> + + getProductSet + \Google\Cloud\Vision\V1\CreateProductSetRequest::getProductSet() + + + Required. The ProductSet to create. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 2 [(.google.api.field_behavior) = REQUIRED];</code> + name="return" + description="" + type="\Google\Cloud\Vision\V1\ProductSet|null"/> - - - - STATE_UNSPECIFIED - \Google\Cloud\Vision\V1\BatchOperationMetadata\State::STATE_UNSPECIFIED - 0 - - Invalid. - Generated from protobuf enum <code>STATE_UNSPECIFIED = 0;</code> - - - - - - PROCESSING - \Google\Cloud\Vision\V1\BatchOperationMetadata\State::PROCESSING - 1 - - Request is actively being processed. - Generated from protobuf enum <code>PROCESSING = 1;</code> - - - - - - SUCCESSFUL - \Google\Cloud\Vision\V1\BatchOperationMetadata\State::SUCCESSFUL - 2 - - The request is done and at least one item has been successfully -processed. - Generated from protobuf enum <code>SUCCESSFUL = 2;</code> - - - - - - FAILED - \Google\Cloud\Vision\V1\BatchOperationMetadata\State::FAILED - 3 - - The request is done and no item has been successfully processed. - Generated from protobuf enum <code>FAILED = 3;</code> - - - + - - CANCELLED - \Google\Cloud\Vision\V1\BatchOperationMetadata\State::CANCELLED - 4 - - The request is done after the longrunning.Operations.CancelOperation has -been called by the user. Any records that were processed before the -cancel command are output as specified in the request. - Generated from protobuf enum <code>CANCELLED = 4;</code> - + + hasProductSet + \Google\Cloud\Vision\V1\CreateProductSetRequest::hasProductSet() + + + + + - + - - - valueToName - \Google\Cloud\Vision\V1\BatchOperationMetadata\State::$valueToName - [self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', self::PROCESSING => 'PROCESSING', self::SUCCESSFUL => 'SUCCESSFUL', self::FAILED => 'FAILED', self::CANCELLED => 'CANCELLED'] - + + clearProductSet + \Google\Cloud\Vision\V1\CreateProductSetRequest::clearProductSet() + + - + - + - - - name - \Google\Cloud\Vision\V1\BatchOperationMetadata\State::name() + + setProductSet + \Google\Cloud\Vision\V1\CreateProductSetRequest::setProductSet() - - value + + var - mixed + \Google\Cloud\Vision\V1\ProductSet - - - - + + Required. The ProductSet to create. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + + - - value - \Google\Cloud\Vision\V1\BatchOperationMetadata\State::value() + + getProductSetId + \Google\Cloud\Vision\V1\CreateProductSetRequest::getProductSetId() - - name + + A user-supplied resource id for this ProductSet. If set, the server will +attempt to use this value as the resource id. If it is already in use, an +error is returned with code ALREADY_EXISTS. Must be at most 128 characters +long. It cannot contain the character `/`. + Generated from protobuf field <code>string product_set_id = 3;</code> + + + + + + + setProductSetId + \Google\Cloud\Vision\V1\CreateProductSetRequest::setProductSetId() + + + var - mixed + string - - - - + + A user-supplied resource id for this ProductSet. If set, the server will +attempt to use this value as the resource id. If it is already in use, an +error is returned with code ALREADY_EXISTS. Must be at most 128 characters +long. It cannot contain the character `/`. + Generated from protobuf field <code>string product_set_id = 3;</code> + + + @@ -9387,7 +8989,7 @@ cancel command are output as specified in the request. - + @@ -9405,15 +9007,13 @@ cancel command are output as specified in the request. - - BatchOperationMetadata - \Google\Cloud\Vision\V1\BatchOperationMetadata - - Metadata for the batch operations such as the current state. - This is included in the `metadata` field of the `Operation` returned by the -`GetOperation` call of the `google::longrunning::Operations` service. - -Generated from protobuf message <code>google.cloud.vision.v1.BatchOperationMetadata</code> + + + CreateReferenceImageRequest + \Google\Cloud\Vision\V1\CreateReferenceImageRequest + + Request message for the `CreateReferenceImage` method. + Generated from protobuf message <code>google.cloud.vision.v1.CreateReferenceImageRequest</code> \Google\Protobuf\Internal\Message - - state - \Google\Cloud\Vision\V1\BatchOperationMetadata::$state - 0 - - The current state of the batch operation. - Generated from protobuf field <code>.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;</code> + + parent + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::$parent + '' + + Required. Resource name of the product in which to create the reference +image. + Format is +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - submit_time - \Google\Cloud\Vision\V1\BatchOperationMetadata::$submit_time + + reference_image + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::$reference_image null - - The time when the batch request was submitted to the server. - Generated from protobuf field <code>.google.protobuf.Timestamp submit_time = 2;</code> + + Required. The reference image to create. + If an image ID is specified, it is ignored. + +Generated from protobuf field <code>.google.cloud.vision.v1.ReferenceImage reference_image = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - end_time - \Google\Cloud\Vision\V1\BatchOperationMetadata::$end_time - null - - The time when the batch request is finished and -[google.longrunning.Operation.done][google.longrunning.Operation.done] is -set to true. - Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 3;</code> + + reference_image_id + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::$reference_image_id + '' + + A user-supplied resource id for the ReferenceImage to be added. If set, +the server will attempt to use this value as the resource id. If it is +already in use, an error is returned with code ALREADY_EXISTS. Must be at +most 128 characters long. It cannot contain the character `/`. + Generated from protobuf field <code>string reference_image_id = 3;</code> - - __construct - \Google\Cloud\Vision\V1\BatchOperationMetadata::__construct() + + build + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::build() - - data - NULL - array + + parent + + string - + + referenceImage + + \Google\Cloud\Vision\V1\ReferenceImage + + + + referenceImageId + + string + + + + + + + + + + + + + + + + __construct + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::__construct() + + + data + null + array + + + Constructor. - - getState - \Google\Cloud\Vision\V1\BatchOperationMetadata::getState() + + getParent + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::getParent() - - The current state of the batch operation. - Generated from protobuf field <code>.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;</code> + + Required. Resource name of the product in which to create the reference +image. + Format is +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + type="string"/> - - setState - \Google\Cloud\Vision\V1\BatchOperationMetadata::setState() + + setParent + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::setParent() - + var - int + string - - The current state of the batch operation. - Generated from protobuf field <code>.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;</code> + + Required. Resource name of the product in which to create the reference +image. + Format is +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + variable="var" type="string"/> - - getSubmitTime - \Google\Cloud\Vision\V1\BatchOperationMetadata::getSubmitTime() + + getReferenceImage + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::getReferenceImage() - - The time when the batch request was submitted to the server. - Generated from protobuf field <code>.google.protobuf.Timestamp submit_time = 2;</code> + + Required. The reference image to create. + If an image ID is specified, it is ignored. + +Generated from protobuf field <code>.google.cloud.vision.v1.ReferenceImage reference_image = 2 [(.google.api.field_behavior) = REQUIRED];</code> + type="\Google\Cloud\Vision\V1\ReferenceImage|null"/> - - hasSubmitTime - \Google\Cloud\Vision\V1\BatchOperationMetadata::hasSubmitTime() + + hasReferenceImage + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::hasReferenceImage() - + - - clearSubmitTime - \Google\Cloud\Vision\V1\BatchOperationMetadata::clearSubmitTime() + + clearReferenceImage + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::clearReferenceImage() - + - - setSubmitTime - \Google\Cloud\Vision\V1\BatchOperationMetadata::setSubmitTime() + + setReferenceImage + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::setReferenceImage() - + var - \Google\Protobuf\Timestamp + \Google\Cloud\Vision\V1\ReferenceImage - - The time when the batch request was submitted to the server. - Generated from protobuf field <code>.google.protobuf.Timestamp submit_time = 2;</code> + + Required. The reference image to create. + If an image ID is specified, it is ignored. + +Generated from protobuf field <code>.google.cloud.vision.v1.ReferenceImage reference_image = 2 [(.google.api.field_behavior) = REQUIRED];</code> + variable="var" type="\Google\Cloud\Vision\V1\ReferenceImage"/> - - getEndTime - \Google\Cloud\Vision\V1\BatchOperationMetadata::getEndTime() + + getReferenceImageId + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::getReferenceImageId() - - The time when the batch request is finished and -[google.longrunning.Operation.done][google.longrunning.Operation.done] is -set to true. - Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 3;</code> + + A user-supplied resource id for the ReferenceImage to be added. If set, +the server will attempt to use this value as the resource id. If it is +already in use, an error is returned with code ALREADY_EXISTS. Must be at +most 128 characters long. It cannot contain the character `/`. + Generated from protobuf field <code>string reference_image_id = 3;</code> + type="string"/> - - hasEndTime - \Google\Cloud\Vision\V1\BatchOperationMetadata::hasEndTime() - - - - - - - - - - clearEndTime - \Google\Cloud\Vision\V1\BatchOperationMetadata::clearEndTime() - - - - - - - - - - setEndTime - \Google\Cloud\Vision\V1\BatchOperationMetadata::setEndTime() + + setReferenceImageId + \Google\Cloud\Vision\V1\CreateReferenceImageRequest::setReferenceImageId() - + var - \Google\Protobuf\Timestamp + string - - The time when the batch request is finished and -[google.longrunning.Operation.done][google.longrunning.Operation.done] is -set to true. - Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 3;</code> + + A user-supplied resource id for the ReferenceImage to be added. If set, +the server will attempt to use this value as the resource id. If it is +already in use, an error is returned with code ALREADY_EXISTS. Must be at +most 128 characters long. It cannot contain the character `/`. + Generated from protobuf field <code>string reference_image_id = 3;</code> + variable="var" type="string"/> - + @@ -9672,174 +9320,222 @@ set to true. - - BatchOperationMetadata_State - \Google\Cloud\Vision\V1\BatchOperationMetadata_State - - This class is deprecated. Use Google\Cloud\Vision\V1\BatchOperationMetadata\State instead. - + + + CropHint + \Google\Cloud\Vision\V1\CropHint + + Single crop hint that is used to generate a new crop when serving an image. + Generated from protobuf message <code>google.cloud.vision.v1.CropHint</code> - + \Google\Protobuf\Internal\Message - - - - - - - - - - - - - - - + + bounding_poly + \Google\Cloud\Vision\V1\CropHint::$bounding_poly + null + + The bounding polygon for the crop region. The coordinates of the bounding +box are in the original image's scale. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + - - - + - - - - - BlockType - \Google\Cloud\Vision\V1\Block\BlockType - - Type of a block (text, image etc) as identified by OCR. - Protobuf type <code>google.cloud.vision.v1.Block.BlockType</code> - - - - - - - UNKNOWN - \Google\Cloud\Vision\V1\Block\BlockType::UNKNOWN - 0 - - Unknown block type. - Generated from protobuf enum <code>UNKNOWN = 0;</code> - - - + + confidence + \Google\Cloud\Vision\V1\CropHint::$confidence + 0.0 + + Confidence of this being a salient region. Range [0, 1]. + Generated from protobuf field <code>float confidence = 2;</code> + - - TEXT - \Google\Cloud\Vision\V1\Block\BlockType::TEXT - 1 - - Regular text block. - Generated from protobuf enum <code>TEXT = 1;</code> - + - + + importance_fraction + \Google\Cloud\Vision\V1\CropHint::$importance_fraction + 0.0 + + Fraction of importance of this salient region with respect to the original +image. + Generated from protobuf field <code>float importance_fraction = 3;</code> + - - TABLE - \Google\Cloud\Vision\V1\Block\BlockType::TABLE - 2 - - Table block. - Generated from protobuf enum <code>TABLE = 2;</code> - + - + + + __construct + \Google\Cloud\Vision\V1\CropHint::__construct() + + + data + null + array + - - PICTURE - \Google\Cloud\Vision\V1\Block\BlockType::PICTURE - 3 - - Image block. - Generated from protobuf enum <code>PICTURE = 3;</code> - + + Constructor. + + + - + - - RULER - \Google\Cloud\Vision\V1\Block\BlockType::RULER - 4 - - Horizontal/vertical line box. - Generated from protobuf enum <code>RULER = 4;</code> - + + getBoundingPoly + \Google\Cloud\Vision\V1\CropHint::getBoundingPoly() + + + The bounding polygon for the crop region. The coordinates of the bounding +box are in the original image's scale. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + + - + - - BARCODE - \Google\Cloud\Vision\V1\Block\BlockType::BARCODE - 5 - - Barcode block. - Generated from protobuf enum <code>BARCODE = 5;</code> - + + hasBoundingPoly + \Google\Cloud\Vision\V1\CropHint::hasBoundingPoly() + + + + + - + - - - valueToName - \Google\Cloud\Vision\V1\Block\BlockType::$valueToName - [self::UNKNOWN => 'UNKNOWN', self::TEXT => 'TEXT', self::TABLE => 'TABLE', self::PICTURE => 'PICTURE', self::RULER => 'RULER', self::BARCODE => 'BARCODE'] - + + clearBoundingPoly + \Google\Cloud\Vision\V1\CropHint::clearBoundingPoly() + + - + - + - - - name - \Google\Cloud\Vision\V1\Block\BlockType::name() + + setBoundingPoly + \Google\Cloud\Vision\V1\CropHint::setBoundingPoly() - - value + + var - mixed + \Google\Cloud\Vision\V1\BoundingPoly - - - - + + The bounding polygon for the crop region. The coordinates of the bounding +box are in the original image's scale. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + + + - - value - \Google\Cloud\Vision\V1\Block\BlockType::value() + + getConfidence + \Google\Cloud\Vision\V1\CropHint::getConfidence() - - name + + Confidence of this being a salient region. Range [0, 1]. + Generated from protobuf field <code>float confidence = 2;</code> + + + + + + + setConfidence + \Google\Cloud\Vision\V1\CropHint::setConfidence() + + + var - mixed + float - - - - + + Confidence of this being a salient region. Range [0, 1]. + Generated from protobuf field <code>float confidence = 2;</code> + + + + + + + + getImportanceFraction + \Google\Cloud\Vision\V1\CropHint::getImportanceFraction() + + + Fraction of importance of this salient region with respect to the original +image. + Generated from protobuf field <code>float importance_fraction = 3;</code> + + + + + + + setImportanceFraction + \Google\Cloud\Vision\V1\CropHint::setImportanceFraction() + + + var + + float + + + + Fraction of importance of this salient region with respect to the original +image. + Generated from protobuf field <code>float importance_fraction = 3;</code> + + + @@ -9849,7 +9545,7 @@ set to true. - + @@ -9867,12 +9563,13 @@ set to true. + - Block - \Google\Cloud\Vision\V1\Block + CropHintsAnnotation + \Google\Cloud\Vision\V1\CropHintsAnnotation - Logical element on the page. - Generated from protobuf message <code>google.cloud.vision.v1.Block</code> + Set of crop hints that are used to generate new crops when serving images. + Generated from protobuf message <code>google.cloud.vision.v1.CropHintsAnnotation</code> \Google\Protobuf\Internal\Message - - property - \Google\Cloud\Vision\V1\Block::$property - null - - Additional information detected for the block. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - - - - - bounding_box - \Google\Cloud\Vision\V1\Block::$bounding_box - null - - The bounding box for the block. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: -* when the text is horizontal it might look like: - 0----1 - | | - 3----2 -* when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> - - - - - - paragraphs - \Google\Cloud\Vision\V1\Block::$paragraphs + + crop_hints + \Google\Cloud\Vision\V1\CropHintsAnnotation::$crop_hints - - List of paragraphs in this block (if this blocks is of type text). - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;</code> - - - - - - block_type - \Google\Cloud\Vision\V1\Block::$block_type - 0 - - Detected block type (text, image etc) for this block. - Generated from protobuf field <code>.google.cloud.vision.v1.Block.BlockType block_type = 4;</code> - - - - - - confidence - \Google\Cloud\Vision\V1\Block::$confidence - 0.0 - - Confidence of the OCR results on the block. Range [0, 1]. - Generated from protobuf field <code>float confidence = 5;</code> + + Crop hint results. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.CropHint crop_hints = 1;</code> - + __construct - \Google\Cloud\Vision\V1\Block::__construct() + \Google\Cloud\Vision\V1\CropHintsAnnotation::__construct() - + data - NULL + null array - + Constructor. - - getProperty - \Google\Cloud\Vision\V1\Block::getProperty() + + getCropHints + \Google\Cloud\Vision\V1\CropHintsAnnotation::getCropHints() - - Additional information detected for the block. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + Crop hint results. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.CropHint crop_hints = 1;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\CropHint>"/> - - hasProperty - \Google\Cloud\Vision\V1\Block::hasProperty() - - - - - - - - - - clearProperty - \Google\Cloud\Vision\V1\Block::clearProperty() - - - - - - - - - - setProperty - \Google\Cloud\Vision\V1\Block::setProperty() + + setCropHints + \Google\Cloud\Vision\V1\CropHintsAnnotation::setCropHints() - + var - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty + \Google\Cloud\Vision\V1\CropHint[] - - Additional information detected for the block. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + Crop hint results. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.CropHint crop_hints = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\CropHint[]"/> - - getBoundingBox - \Google\Cloud\Vision\V1\Block::getBoundingBox() - - - The bounding box for the block. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: -* when the text is horizontal it might look like: - 0----1 - | | - 3----2 -* when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). + + + + + + + + + + + + -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + + + + + + + + + + + CropHintsParams + \Google\Cloud\Vision\V1\CropHintsParams + + Parameters for crop hints annotation request. + Generated from protobuf message <code>google.cloud.vision.v1.CropHintsParams</code> + name="package" + description="Application" + /> - + \Google\Protobuf\Internal\Message + + + + aspect_ratios + \Google\Cloud\Vision\V1\CropHintsParams::$aspect_ratios + + + Aspect ratios in floats, representing the ratio of the width to the height +of the image. For example, if the desired aspect ratio is 4/3, the +corresponding float value should be 1.33333. If not specified, the +best possible crop is returned. The number of provided aspect ratios is +limited to a maximum of 16; any aspect ratios provided after the 16th are +ignored. + Generated from protobuf field <code>repeated float aspect_ratios = 1;</code> + - - hasBoundingBox - \Google\Cloud\Vision\V1\Block::hasBoundingBox() + + + + + __construct + \Google\Cloud\Vision\V1\CropHintsParams::__construct() - - + + data + null + array + + + + Constructor. - + + - - clearBoundingBox - \Google\Cloud\Vision\V1\Block::clearBoundingBox() + + getAspectRatios + \Google\Cloud\Vision\V1\CropHintsParams::getAspectRatios() - - - - + + Aspect ratios in floats, representing the ratio of the width to the height +of the image. For example, if the desired aspect ratio is 4/3, the +corresponding float value should be 1.33333. If not specified, the +best possible crop is returned. The number of provided aspect ratios is +limited to a maximum of 16; any aspect ratios provided after the 16th are +ignored. + Generated from protobuf field <code>repeated float aspect_ratios = 1;</code> + + - - setBoundingBox - \Google\Cloud\Vision\V1\Block::setBoundingBox() + + setAspectRatios + \Google\Cloud\Vision\V1\CropHintsParams::setAspectRatios() - + var - \Google\Cloud\Vision\V1\BoundingPoly + float[] - - The bounding box for the block. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: -* when the text is horizontal it might look like: - 0----1 - | | - 3----2 -* when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + + Aspect ratios in floats, representing the ratio of the width to the height +of the image. For example, if the desired aspect ratio is 4/3, the +corresponding float value should be 1.33333. If not specified, the +best possible crop is returned. The number of provided aspect ratios is +limited to a maximum of 16; any aspect ratios provided after the 16th are +ignored. + Generated from protobuf field <code>repeated float aspect_ratios = 1;</code> + variable="var" type="float[]"/> - - getParagraphs - \Google\Cloud\Vision\V1\Block::getParagraphs() - - - List of paragraphs in this block (if this blocks is of type text). - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;</code> + + + + + + + + + + + name="package" + description="Application" + /> + + + + + + + + + + + + + DeleteProductRequest + \Google\Cloud\Vision\V1\DeleteProductRequest + + Request message for the `DeleteProduct` method. + Generated from protobuf message <code>google.cloud.vision.v1.DeleteProductRequest</code> + - + \Google\Protobuf\Internal\Message + + + + name + \Google\Cloud\Vision\V1\DeleteProductRequest::$name + '' + + Required. Resource name of product to delete. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - - setParagraphs - \Google\Cloud\Vision\V1\Block::setParagraphs() +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + + build + \Google\Cloud\Vision\V1\DeleteProductRequest::build() - - var + + name - \Google\Cloud\Vision\V1\Paragraph[]|\Google\Protobuf\Internal\RepeatedField + string - - List of paragraphs in this block (if this blocks is of type text). - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;</code> + + + + description="Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` Please see {@see \Google\Cloud\Vision\V1\ProductSearchClient::productName()} for help formatting this field." + variable="name" type="string"/> - - - - - - getBlockType - \Google\Cloud\Vision\V1\Block::getBlockType() - - - Detected block type (text, image etc) for this block. - Generated from protobuf field <code>.google.cloud.vision.v1.Block.BlockType block_type = 4;</code> - + + /> - - setBlockType - \Google\Cloud\Vision\V1\Block::setBlockType() + + __construct + \Google\Cloud\Vision\V1\DeleteProductRequest::__construct() - - var - - int + + data + null + array - - Detected block type (text, image etc) for this block. - Generated from protobuf field <code>.google.cloud.vision.v1.Block.BlockType block_type = 4;</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type string $name Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` }" + variable="data" type="array"/> - - getConfidence - \Google\Cloud\Vision\V1\Block::getConfidence() + + getName + \Google\Cloud\Vision\V1\DeleteProductRequest::getName() - - Confidence of the OCR results on the block. Range [0, 1]. - Generated from protobuf field <code>float confidence = 5;</code> + + Required. Resource name of product to delete. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + type="string"/> - - setConfidence - \Google\Cloud\Vision\V1\Block::setConfidence() + + setName + \Google\Cloud\Vision\V1\DeleteProductRequest::setName() - + var - float + string - - Confidence of the OCR results on the block. Range [0, 1]. - Generated from protobuf field <code>float confidence = 5;</code> + + Required. Resource name of product to delete. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + variable="var" type="string"/> - + @@ -10272,56 +9955,13 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - - Block_BlockType - \Google\Cloud\Vision\V1\Block_BlockType - - This class is deprecated. Use Google\Cloud\Vision\V1\Block\BlockType instead. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BoundingPoly - \Google\Cloud\Vision\V1\BoundingPoly + DeleteProductSetRequest + \Google\Cloud\Vision\V1\DeleteProductSetRequest - A bounding polygon for the detected image annotation. - Generated from protobuf message <code>google.cloud.vision.v1.BoundingPoly</code> + Request message for the `DeleteProductSet` method. + Generated from protobuf message <code>google.cloud.vision.v1.DeleteProductSetRequest</code> \Google\Protobuf\Internal\Message - - vertices - \Google\Cloud\Vision\V1\BoundingPoly::$vertices - - - The bounding polygon vertices. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Vertex vertices = 1;</code> + + name + \Google\Cloud\Vision\V1\DeleteProductSetRequest::$name + '' + + Required. Resource name of the ProductSet to delete. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - normalized_vertices - \Google\Cloud\Vision\V1\BoundingPoly::$normalized_vertices + + + build + \Google\Cloud\Vision\V1\DeleteProductSetRequest::build() + + + name - - The bounding polygon normalized vertices. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.NormalizedVertex normalized_vertices = 2;</code> - + string + - + + + + + + + - - + + + __construct - \Google\Cloud\Vision\V1\BoundingPoly::__construct() + \Google\Cloud\Vision\V1\DeleteProductSetRequest::__construct() - + data - NULL + null array - + Constructor. - - getVertices - \Google\Cloud\Vision\V1\BoundingPoly::getVertices() + + getName + \Google\Cloud\Vision\V1\DeleteProductSetRequest::getName() - - The bounding polygon vertices. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Vertex vertices = 1;</code> + + Required. Resource name of the ProductSet to delete. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + type="string"/> - - setVertices - \Google\Cloud\Vision\V1\BoundingPoly::setVertices() + + setName + \Google\Cloud\Vision\V1\DeleteProductSetRequest::setName() - + var - \Google\Cloud\Vision\V1\Vertex[]|\Google\Protobuf\Internal\RepeatedField + string - - The bounding polygon vertices. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Vertex vertices = 1;</code> + + Required. Resource name of the ProductSet to delete. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + variable="var" type="string"/> - - getNormalizedVertices - \Google\Cloud\Vision\V1\BoundingPoly::getNormalizedVertices() + + + + + + + + + + + + + + + + + + + + + + + + DeleteReferenceImageRequest + \Google\Cloud\Vision\V1\DeleteReferenceImageRequest + + Request message for the `DeleteReferenceImage` method. + Generated from protobuf message <code>google.cloud.vision.v1.DeleteReferenceImageRequest</code> + + + + \Google\Protobuf\Internal\Message + + + + name + \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::$name + '' + + Required. The resource name of the reference image to delete. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + + build + \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::build() - - The bounding polygon normalized vertices. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.NormalizedVertex normalized_vertices = 2;</code> + + name + + string + + + + + + + type="\Google\Cloud\Vision\V1\DeleteReferenceImageRequest"/> + - - setNormalizedVertices - \Google\Cloud\Vision\V1\BoundingPoly::setNormalizedVertices() + + __construct + \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::__construct() - + + data + null + array + + + + Constructor. + + + + + + + + getName + \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::getName() + + + Required. The resource name of the reference image to delete. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + + setName + \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::setName() + + var - \Google\Cloud\Vision\V1\NormalizedVertex[]|\Google\Protobuf\Internal\RepeatedField + string - - The bounding polygon normalized vertices. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.NormalizedVertex normalized_vertices = 2;</code> + + Required. The resource name of the reference image to delete. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + variable="var" type="string"/> - + @@ -10473,14074 +10251,1207 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - + - - ImageAnnotatorClient - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient - - Service Description: Service that performs Google Cloud Vision API detection tasks over client -images, such as face, landmark, logo, label, and text detection. The -ImageAnnotator service returns detected entities from the images. - This class provides the ability to make remote calls to the backing service through method -calls that map to API methods. - -Many parameters require resource names to be formatted in a particular way. To -assist with these names, this class includes a format method for each type of -name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. + + + DominantColorsAnnotation + \Google\Cloud\Vision\V1\DominantColorsAnnotation + + Set of dominant colors and their corresponding scores. + Generated from protobuf message <code>google.cloud.vision.v1.DominantColorsAnnotation</code> - - - - + \Google\Protobuf\Internal\Message - - - SERVICE_NAME - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::SERVICE_NAME - 'google.cloud.vision.v1.ImageAnnotator' - - The name of the service. - - - - - - - SERVICE_ADDRESS - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::SERVICE_ADDRESS - 'vision.googleapis.com' - - The default address of the service. - - - - - - - - SERVICE_ADDRESS_TEMPLATE - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::SERVICE_ADDRESS_TEMPLATE - 'vision.UNIVERSE_DOMAIN' - - The address template of the service. - - - - - - - DEFAULT_SERVICE_PORT - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::DEFAULT_SERVICE_PORT - 443 - - The default port of the service. - - - - - - - CODEGEN_NAME - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::CODEGEN_NAME - 'gapic' - - The name of the code generator, to be included in the agent header. - - - - - - - serviceScopes - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::$serviceScopes - ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - - The default scopes required by the service. - - - - - - - operationsClient - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::$operationsClient + + colors + \Google\Cloud\Vision\V1\DominantColorsAnnotation::$colors - - - + + RGB color values with their score and pixel fraction. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ColorInfo colors = 1;</code> - - getClientDefaults - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::getClientDefaults() + + __construct + \Google\Cloud\Vision\V1\DominantColorsAnnotation::__construct() - - - - - - + + data + null + array + - - getOperationsClient - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::getOperationsClient() - - - Return an OperationsClient object with the same endpoint as $this. + + Constructor. + name="param" + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\ColorInfo[] $colors RGB color values with their score and pixel fraction. }" + variable="data" type="array"/> - - resumeOperation - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::resumeOperation() + + getColors + \Google\Cloud\Vision\V1\DominantColorsAnnotation::getColors() - - operationName - - string - - - - methodName - null - string - - - - Resume an existing long running operation that was previously started by a long -running API method. If $methodName is not provided, or does not match a long -running API method, then the operation can still be resumed, but the -OperationResponse object will not deserialize the final response. - + + RGB color values with their score and pixel fraction. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ColorInfo colors = 1;</code> - - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\ColorInfo>"/> - - productSetName - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::productSetName() + + setColors + \Google\Cloud\Vision\V1\DominantColorsAnnotation::setColors() - - project - - string - - - - location - - string - - - - productSet + + var - string + \Google\Cloud\Vision\V1\ColorInfo[] - - Formats a string containing the fully-qualified path to represent a product_set -resource. - + + RGB color values with their score and pixel fraction. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ColorInfo colors = 1;</code> - - + variable="var" type="\Google\Cloud\Vision\V1\ColorInfo[]"/> + description="" + type="$this"/> - - parseName - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::parseName() - - - formattedName - - string - + + + + + + + + + + + + - - template - null - string - - - Parses a formatted name string and returns an associative array of the components in the name. - The following name formats are supported: -Template: Pattern -- productSet: projects/{project}/locations/{location}/productSets/{product_set} + + + -The optional $template argument can be supplied to specify a particular pattern, -and must match one of the templates listed above. If no $template argument is -provided, or if the $template argument does not match one of the templates -listed, then parseName will check each of the supported templates, and return -the first match. + + + + + + EntityAnnotation + \Google\Cloud\Vision\V1\EntityAnnotation + + Set of detected entity features. + Generated from protobuf message <code>google.cloud.vision.v1.EntityAnnotation</code> - - - + name="package" + description="Application" + /> - + \Google\Protobuf\Internal\Message + + + + mid + \Google\Cloud\Vision\V1\EntityAnnotation::$mid + '' + + Opaque entity ID. Some IDs may be available in +[Google Knowledge Graph Search +API](https://developers.google.com/knowledge-graph/). + Generated from protobuf field <code>string mid = 1;</code> + - - __construct - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::__construct() - - - options - [] - array - + - - Constructor. - + + locale + \Google\Cloud\Vision\V1\EntityAnnotation::$locale + '' + + The language code for the locale in which the entity textual +`description` is expressed. + Generated from protobuf field <code>string locale = 2;</code> + + + + + + description + \Google\Cloud\Vision\V1\EntityAnnotation::$description + '' + + Entity textual description, expressed in its `locale` language. + Generated from protobuf field <code>string description = 3;</code> + + + + + + score + \Google\Cloud\Vision\V1\EntityAnnotation::$score + 0.0 + + Overall score of the result. Range [0, 1]. + Generated from protobuf field <code>float score = 4;</code> + + + + + + confidence + \Google\Cloud\Vision\V1\EntityAnnotation::$confidence + 0.0 + + **Deprecated. Use `score` instead.** +The accuracy of the entity detection in an image. + For example, for an image in which the "Eiffel Tower" entity is detected, +this field represents the confidence that there is a tower in the query +image. Range [0, 1]. + +Generated from protobuf field <code>float confidence = 5 [deprecated = true];</code> - - + /> + - + - - __call - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::__call() - - - method - - mixed - + + topicality + \Google\Cloud\Vision\V1\EntityAnnotation::$topicality + 0.0 + + The relevancy of the ICA (Image Content Annotation) label to the +image. For example, the relevancy of "tower" is likely higher to an image +containing the detected "Eiffel Tower" than to an image containing a +detected distant towering building, even though the confidence that +there is a tower in each image may be the same. Range [0, 1]. + Generated from protobuf field <code>float topicality = 6;</code> + - - args + + + + bounding_poly + \Google\Cloud\Vision\V1\EntityAnnotation::$bounding_poly + null + + Image region to which this entity belongs. Not produced +for `LABEL_DETECTION` features. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;</code> + + + + + + locations + \Google\Cloud\Vision\V1\EntityAnnotation::$locations - mixed - + + The location information for the detected entity. Multiple +`LocationInfo` elements can be present because one location may +indicate the location of the scene in the image, and another location +may indicate the location of the place where the image was taken. + Location information is usually present for landmarks. - - Handles execution of the async variants for each documented method. - +Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocationInfo locations = 8;</code> - + - - asyncBatchAnnotateFiles - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateFiles() - - - request + + properties + \Google\Cloud\Vision\V1\EntityAnnotation::$properties - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest - + + Some entities may have optional user-supplied `Property` (name/value) +fields, such a score or string that qualifies the entity. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Property properties = 9;</code> + - - callOptions - [] + + + + + __construct + \Google\Cloud\Vision\V1\EntityAnnotation::__construct() + + + data + null array - - Run asynchronous image detection and annotation for a list of generic -files, such as PDF files, which may contain multiple pages and multiple -images per page. Progress and results can be retrieved through the -`google.longrunning.Operations` interface. - `Operation.metadata` contains `OperationMetadata` (metadata). -`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateFilesAsync()} -. + + Constructor. + - - - + + + + + + getMid + \Google\Cloud\Vision\V1\EntityAnnotation::getMid() + + + Opaque entity ID. Some IDs may be available in +[Google Knowledge Graph Search +API](https://developers.google.com/knowledge-graph/). + Generated from protobuf field <code>string mid = 1;</code> + - + type="string"/> - - asyncBatchAnnotateImages - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImages() + + setMid + \Google\Cloud\Vision\V1\EntityAnnotation::setMid() - - request + + var - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest - - - - callOptions - [] - array + string - - Run asynchronous image detection and annotation for a list of images. - Progress and results can be retrieved through the -`google.longrunning.Operations` interface. -`Operation.metadata` contains `OperationMetadata` (metadata). -`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - -This service will write image annotation outputs to json files in customer -GCS bucket, each json file containing BatchAnnotateImagesResponse proto. - -The async variant is -{@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImagesAsync()} . + + Opaque entity ID. Some IDs may be available in +[Google Knowledge Graph Search +API](https://developers.google.com/knowledge-graph/). + Generated from protobuf field <code>string mid = 1;</code> - - + description="" + variable="var" type="string"/> - + type="$this"/> - - batchAnnotateFiles - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFiles() + + getLocale + \Google\Cloud\Vision\V1\EntityAnnotation::getLocale() - - request + + The language code for the locale in which the entity textual +`description` is expressed. + Generated from protobuf field <code>string locale = 2;</code> + + + + + + + setLocale + \Google\Cloud\Vision\V1\EntityAnnotation::setLocale() + + + var - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest + string - - callOptions - [] - array - - - - Service that performs image detection and annotation for a batch of files. - Now only "application/pdf", "image/tiff" and "image/gif" are supported. - -This service will extract at most 5 (customers can specify which 5 in -AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each -file provided and perform detection and annotation for each image -extracted. - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFilesAsync()} . + + The language code for the locale in which the entity textual +`description` is expressed. + Generated from protobuf field <code>string locale = 2;</code> - - + description="" + variable="var" type="string"/> - + type="$this"/> - - batchAnnotateImages - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImages() + + getDescription + \Google\Cloud\Vision\V1\EntityAnnotation::getDescription() - - request - - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest - + + Entity textual description, expressed in its `locale` language. + Generated from protobuf field <code>string description = 3;</code> + + - - callOptions - [] - array + + + + setDescription + \Google\Cloud\Vision\V1\EntityAnnotation::setDescription() + + + var + + string - - Run image detection and annotation for a batch of images. - The async variant is {@see \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImagesAsync()} . + + Entity textual description, expressed in its `locale` language. + Generated from protobuf field <code>string description = 3;</code> - - + description="" + variable="var" type="string"/> - + type="$this"/> - - asyncBatchAnnotateFilesAsync - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateFilesAsync() + + getScore + \Google\Cloud\Vision\V1\EntityAnnotation::getScore() - - request - - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest - - - - optionalArgs - [] - array - - - - - + + Overall score of the result. Range [0, 1]. + Generated from protobuf field <code>float score = 4;</code> - + type="float"/> + - - asyncBatchAnnotateImagesAsync - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImagesAsync() + + setScore + \Google\Cloud\Vision\V1\EntityAnnotation::setScore() - - request + + var - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest - - - - optionalArgs - [] - array + float - - - + + Overall score of the result. Range [0, 1]. + Generated from protobuf field <code>float score = 4;</code> + - + type="$this"/> + - - batchAnnotateFilesAsync - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFilesAsync() + + getConfidence + \Google\Cloud\Vision\V1\EntityAnnotation::getConfidence() - - request - - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest - - - - optionalArgs - [] - array - + + **Deprecated. Use `score` instead.** +The accuracy of the entity detection in an image. + For example, for an image in which the "Eiffel Tower" entity is detected, +this field represents the confidence that there is a tower in the query +image. Range [0, 1]. - - - +Generated from protobuf field <code>float confidence = 5 [deprecated = true];</code> - + type="float"/> + + - - batchAnnotateImagesAsync - \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateImagesAsync() + + setConfidence + \Google\Cloud\Vision\V1\EntityAnnotation::setConfidence() - - request + + var - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest + float - - optionalArgs - [] - array - + + **Deprecated. Use `score` instead.** +The accuracy of the entity detection in an image. + For example, for an image in which the "Eiffel Tower" entity is detected, +this field represents the confidence that there is a tower in the query +image. Range [0, 1]. - - - +Generated from protobuf field <code>float confidence = 5 [deprecated = true];</code> + - + type="$this"/> + + - - - - - - - - - - + + getTopicality + \Google\Cloud\Vision\V1\EntityAnnotation::getTopicality() + + + The relevancy of the ICA (Image Content Annotation) label to the +image. For example, the relevancy of "tower" is likely higher to an image +containing the detected "Eiffel Tower" than to an image containing a +detected distant towering building, even though the confidence that +there is a tower in each image may be the same. Range [0, 1]. + Generated from protobuf field <code>float topicality = 6;</code> - - + name="return" + description="" + type="float"/> + - - - + - - - - - ProductSearchClient - \Google\Cloud\Vision\V1\Client\ProductSearchClient - - Service Description: Manages Products and ProductSets of reference images for use in product -search. It uses the following resource model: - - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet] -resources, named `projects/&#42;/locations/&#42;/productSets/*`, which acts as a way -to put different products into groups to limit identification. - -In parallel, - -- The API has a collection of [Product][google.cloud.vision.v1.Product] -resources, named -`projects/&#42;/locations/&#42;/products/*` - -- Each [Product][google.cloud.vision.v1.Product] has a collection of -[ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named -`projects/&#42;/locations/&#42;/products/&#42;/referenceImages/*` - -This class provides the ability to make remote calls to the backing service through method -calls that map to API methods. + + setTopicality + \Google\Cloud\Vision\V1\EntityAnnotation::setTopicality() + + + var + + float + -Many parameters require resource names to be formatted in a particular way. To -assist with these names, this class includes a format method for each type of -name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. + + The relevancy of the ICA (Image Content Annotation) label to the +image. For example, the relevancy of "tower" is likely higher to an image +containing the detected "Eiffel Tower" than to an image containing a +detected distant towering building, even though the confidence that +there is a tower in each image may be the same. Range [0, 1]. + Generated from protobuf field <code>float topicality = 6;</code> - - - - - - - - - - - - - - - - - - + variable="var" type="float"/> + name="return" + description="" + type="$this"/> - - - - SERVICE_NAME - \Google\Cloud\Vision\V1\Client\ProductSearchClient::SERVICE_NAME - 'google.cloud.vision.v1.ProductSearch' - - The name of the service. - - - - + - - SERVICE_ADDRESS - \Google\Cloud\Vision\V1\Client\ProductSearchClient::SERVICE_ADDRESS - 'vision.googleapis.com' - - The default address of the service. - + + getBoundingPoly + \Google\Cloud\Vision\V1\EntityAnnotation::getBoundingPoly() + + + Image region to which this entity belongs. Not produced +for `LABEL_DETECTION` features. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;</code> - - - - - - SERVICE_ADDRESS_TEMPLATE - \Google\Cloud\Vision\V1\Client\ProductSearchClient::SERVICE_ADDRESS_TEMPLATE - 'vision.UNIVERSE_DOMAIN' - - The address template of the service. - - - - - - - DEFAULT_SERVICE_PORT - \Google\Cloud\Vision\V1\Client\ProductSearchClient::DEFAULT_SERVICE_PORT - 443 - - The default port of the service. - - - - - - - CODEGEN_NAME - \Google\Cloud\Vision\V1\Client\ProductSearchClient::CODEGEN_NAME - 'gapic' - - The name of the code generator, to be included in the agent header. - - - - - - - - serviceScopes - \Google\Cloud\Vision\V1\Client\ProductSearchClient::$serviceScopes - ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - - The default scopes required by the service. - - - - - - - operationsClient - \Google\Cloud\Vision\V1\Client\ProductSearchClient::$operationsClient - - - - - + name="return" + description="" + type="\Google\Cloud\Vision\V1\BoundingPoly|null"/> + - + - - - getClientDefaults - \Google\Cloud\Vision\V1\Client\ProductSearchClient::getClientDefaults() + + hasBoundingPoly + \Google\Cloud\Vision\V1\EntityAnnotation::hasBoundingPoly() - + - - getOperationsClient - \Google\Cloud\Vision\V1\Client\ProductSearchClient::getOperationsClient() + + clearBoundingPoly + \Google\Cloud\Vision\V1\EntityAnnotation::clearBoundingPoly() - - Return an OperationsClient object with the same endpoint as $this. + + - - + - - resumeOperation - \Google\Cloud\Vision\V1\Client\ProductSearchClient::resumeOperation() + + setBoundingPoly + \Google\Cloud\Vision\V1\EntityAnnotation::setBoundingPoly() - - operationName + + var - string - - - - methodName - null - string + \Google\Cloud\Vision\V1\BoundingPoly - - Resume an existing long running operation that was previously started by a long -running API method. If $methodName is not provided, or does not match a long -running API method, then the operation can still be resumed, but the -OperationResponse object will not deserialize the final response. - + + Image region to which this entity belongs. Not produced +for `LABEL_DETECTION` features. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;</code> - + description="" + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> + type="$this"/> - - locationName - \Google\Cloud\Vision\V1\Client\ProductSearchClient::locationName() - - - project - - string - - - - location - - string - + + getLocations + \Google\Cloud\Vision\V1\EntityAnnotation::getLocations() + + + The location information for the detected entity. Multiple +`LocationInfo` elements can be present because one location may +indicate the location of the scene in the image, and another location +may indicate the location of the place where the image was taken. + Location information is usually present for landmarks. - - Formats a string containing the fully-qualified path to represent a location -resource. - +Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocationInfo locations = 8;</code> - - + description="" + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\LocationInfo>"/> - - productName - \Google\Cloud\Vision\V1\Client\ProductSearchClient::productName() + + setLocations + \Google\Cloud\Vision\V1\EntityAnnotation::setLocations() - - project - - string - - - - location + + var - string + \Google\Cloud\Vision\V1\LocationInfo[] - - product - - string - + + The location information for the detected entity. Multiple +`LocationInfo` elements can be present because one location may +indicate the location of the scene in the image, and another location +may indicate the location of the place where the image was taken. + Location information is usually present for landmarks. - - Formats a string containing the fully-qualified path to represent a product -resource. - +Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocationInfo locations = 8;</code> - - + variable="var" type="\Google\Cloud\Vision\V1\LocationInfo[]"/> + description="" + type="$this"/> - - productSetName - \Google\Cloud\Vision\V1\Client\ProductSearchClient::productSetName() + + getProperties + \Google\Cloud\Vision\V1\EntityAnnotation::getProperties() - - project - - string - - - - location - - string - - - - productSet - - string - - - - Formats a string containing the fully-qualified path to represent a product_set -resource. - + + Some entities may have optional user-supplied `Property` (name/value) +fields, such a score or string that qualifies the entity. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Property properties = 9;</code> - - - + description="" + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Property>"/> - - referenceImageName - \Google\Cloud\Vision\V1\Client\ProductSearchClient::referenceImageName() + + setProperties + \Google\Cloud\Vision\V1\EntityAnnotation::setProperties() - - project - - string - - - - location - - string - - - - product - - string - - - - referenceImage + + var - string + \Google\Cloud\Vision\V1\Property[] - - Formats a string containing the fully-qualified path to represent a -reference_image resource. - + + Some entities may have optional user-supplied `Property` (name/value) +fields, such a score or string that qualifies the entity. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Property properties = 9;</code> - - - + variable="var" type="\Google\Cloud\Vision\V1\Property[]"/> + description="" + type="$this"/> - - parseName - \Google\Cloud\Vision\V1\Client\ProductSearchClient::parseName() - - - formattedName - - string - + + + + + + + + + + + + - - template - null - string - - - Parses a formatted name string and returns an associative array of the components in the name. - The following name formats are supported: -Template: Pattern -- location: projects/{project}/locations/{location} -- product: projects/{project}/locations/{location}/products/{product} -- productSet: projects/{project}/locations/{location}/productSets/{product_set} -- referenceImage: projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image} + + + -The optional $template argument can be supplied to specify a particular pattern, -and must match one of the templates listed above. If no $template argument is -provided, or if the $template argument does not match one of the templates -listed, then parseName will check each of the supported templates, and return -the first match. + + + + + + Type + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type + + Face landmark (feature) type. + Left and right are defined from the vantage of the viewer of the image +without considering mirror projections typical of photos. So, `LEFT_EYE`, +typically, is the person's right eye. + +Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type</code> - - - + name="package" + description="Application" + /> - + + + + UNKNOWN_LANDMARK + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::UNKNOWN_LANDMARK + 0 + + Unknown face landmark detected. Should not be filled. + Generated from protobuf enum <code>UNKNOWN_LANDMARK = 0;</code> + - - __construct - \Google\Cloud\Vision\V1\Client\ProductSearchClient::__construct() - - - options - [] - array - + - - Constructor. - - - - + + LEFT_EYE + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE + 1 + + Left eye. + Generated from protobuf enum <code>LEFT_EYE = 1;</code> + - + - - __call - \Google\Cloud\Vision\V1\Client\ProductSearchClient::__call() - - - method - - mixed - + + RIGHT_EYE + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE + 2 + + Right eye. + Generated from protobuf enum <code>RIGHT_EYE = 2;</code> + - - args - - mixed - + - - Handles execution of the async variants for each documented method. - + + LEFT_OF_LEFT_EYEBROW + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_OF_LEFT_EYEBROW + 3 + + Left of left eyebrow. + Generated from protobuf enum <code>LEFT_OF_LEFT_EYEBROW = 3;</code> - + - - addProductToProductSet - \Google\Cloud\Vision\V1\Client\ProductSearchClient::addProductToProductSet() - - - request - - \Google\Cloud\Vision\V1\AddProductToProductSetRequest - + + RIGHT_OF_LEFT_EYEBROW + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_OF_LEFT_EYEBROW + 4 + + Right of left eyebrow. + Generated from protobuf enum <code>RIGHT_OF_LEFT_EYEBROW = 4;</code> + - - callOptions - [] - array - + - - Adds a Product to the specified ProductSet. If the Product is already -present, no change is made. - One Product can be added to at most 100 ProductSets. + + LEFT_OF_RIGHT_EYEBROW + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_OF_RIGHT_EYEBROW + 5 + + Left of right eyebrow. + Generated from protobuf enum <code>LEFT_OF_RIGHT_EYEBROW = 5;</code> + -Possible errors: + -* Returns NOT_FOUND if the Product or the ProductSet doesn't exist. + + RIGHT_OF_RIGHT_EYEBROW + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_OF_RIGHT_EYEBROW + 6 + + Right of right eyebrow. + Generated from protobuf enum <code>RIGHT_OF_RIGHT_EYEBROW = 6;</code> + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::addProductToProductSetAsync()} . - - - - - + - + + MIDPOINT_BETWEEN_EYES + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::MIDPOINT_BETWEEN_EYES + 7 + + Midpoint between eyes. + Generated from protobuf enum <code>MIDPOINT_BETWEEN_EYES = 7;</code> + - - createProduct - \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProduct() - - - request - - \Google\Cloud\Vision\V1\CreateProductRequest - + - - callOptions - [] - array - + + NOSE_TIP + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::NOSE_TIP + 8 + + Nose tip. + Generated from protobuf enum <code>NOSE_TIP = 8;</code> + - - Creates and returns a new product resource. - Possible errors: + -* Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 -characters. -* Returns INVALID_ARGUMENT if description is longer than 4096 characters. -* Returns INVALID_ARGUMENT if product_category is missing or invalid. + + UPPER_LIP + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::UPPER_LIP + 9 + + Upper lip. + Generated from protobuf enum <code>UPPER_LIP = 9;</code> + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductAsync()} . - - - - - - + - + + LOWER_LIP + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LOWER_LIP + 10 + + Lower lip. + Generated from protobuf enum <code>LOWER_LIP = 10;</code> + - - createProductSet - \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductSet() - - - request - - \Google\Cloud\Vision\V1\CreateProductSetRequest - + - - callOptions - [] - array - + + MOUTH_LEFT + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::MOUTH_LEFT + 11 + + Mouth left. + Generated from protobuf enum <code>MOUTH_LEFT = 11;</code> + - - Creates and returns a new ProductSet resource. - Possible errors: + -* Returns INVALID_ARGUMENT if display_name is missing, or is longer than -4096 characters. + + MOUTH_RIGHT + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::MOUTH_RIGHT + 12 + + Mouth right. + Generated from protobuf enum <code>MOUTH_RIGHT = 12;</code> + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductSetAsync()} . - - - - - - + - + + MOUTH_CENTER + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::MOUTH_CENTER + 13 + + Mouth center. + Generated from protobuf enum <code>MOUTH_CENTER = 13;</code> + - - createReferenceImage - \Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImage() - - - request - - \Google\Cloud\Vision\V1\CreateReferenceImageRequest - + - - callOptions - [] - array - + + NOSE_BOTTOM_RIGHT + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::NOSE_BOTTOM_RIGHT + 14 + + Nose, bottom right. + Generated from protobuf enum <code>NOSE_BOTTOM_RIGHT = 14;</code> + - - Creates and returns a new ReferenceImage resource. - The `bounding_poly` field is optional. If `bounding_poly` is not specified, -the system will try to detect regions of interest in the image that are -compatible with the product_category on the parent product. If it is -specified, detection is ALWAYS skipped. The system converts polygons into -non-rotated rectangles. + -Note that the pipeline will resize the image if the image resolution is too -large to process (above 50MP). + + NOSE_BOTTOM_LEFT + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::NOSE_BOTTOM_LEFT + 15 + + Nose, bottom left. + Generated from protobuf enum <code>NOSE_BOTTOM_LEFT = 15;</code> + -Possible errors: + -* Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 -characters. -* Returns INVALID_ARGUMENT if the product does not exist. -* Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing -compatible with the parent product's product_category is detected. -* Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. + + NOSE_BOTTOM_CENTER + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::NOSE_BOTTOM_CENTER + 16 + + Nose, bottom center. + Generated from protobuf enum <code>NOSE_BOTTOM_CENTER = 16;</code> + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImageAsync()} . - - - - - - + - + + LEFT_EYE_TOP_BOUNDARY + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_TOP_BOUNDARY + 17 + + Left eye, top boundary. + Generated from protobuf enum <code>LEFT_EYE_TOP_BOUNDARY = 17;</code> + - - deleteProduct - \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProduct() - - - request - - \Google\Cloud\Vision\V1\DeleteProductRequest - + - - callOptions - [] - array - + + LEFT_EYE_RIGHT_CORNER + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_RIGHT_CORNER + 18 + + Left eye, right corner. + Generated from protobuf enum <code>LEFT_EYE_RIGHT_CORNER = 18;</code> + - - Permanently deletes a product and its reference images. - Metadata of the product and all its images will be deleted right away, but -search queries against ProductSets containing the product may still work -until all related caches are refreshed. + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductAsync()} . - - - - - + + LEFT_EYE_BOTTOM_BOUNDARY + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_BOTTOM_BOUNDARY + 19 + + Left eye, bottom boundary. + Generated from protobuf enum <code>LEFT_EYE_BOTTOM_BOUNDARY = 19;</code> + - + - - deleteProductSet - \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSet() - - - request - - \Google\Cloud\Vision\V1\DeleteProductSetRequest - + + LEFT_EYE_LEFT_CORNER + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_LEFT_CORNER + 20 + + Left eye, left corner. + Generated from protobuf enum <code>LEFT_EYE_LEFT_CORNER = 20;</code> + - - callOptions - [] - array - + - - Permanently deletes a ProductSet. Products and ReferenceImages in the -ProductSet are not deleted. - The actual image files are not deleted from Google Cloud Storage. + + RIGHT_EYE_TOP_BOUNDARY + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_TOP_BOUNDARY + 21 + + Right eye, top boundary. + Generated from protobuf enum <code>RIGHT_EYE_TOP_BOUNDARY = 21;</code> + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSetAsync()} . - - - - - + - + + RIGHT_EYE_RIGHT_CORNER + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_RIGHT_CORNER + 22 + + Right eye, right corner. + Generated from protobuf enum <code>RIGHT_EYE_RIGHT_CORNER = 22;</code> + - - deleteReferenceImage - \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImage() - - - request - - \Google\Cloud\Vision\V1\DeleteReferenceImageRequest - + - - callOptions - [] - array - + + RIGHT_EYE_BOTTOM_BOUNDARY + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_BOTTOM_BOUNDARY + 23 + + Right eye, bottom boundary. + Generated from protobuf enum <code>RIGHT_EYE_BOTTOM_BOUNDARY = 23;</code> + - - Permanently deletes a reference image. - The image metadata will be deleted right away, but search queries -against ProductSets containing the image may still work until all related -caches are refreshed. + -The actual image files are not deleted from Google Cloud Storage. + + RIGHT_EYE_LEFT_CORNER + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_LEFT_CORNER + 24 + + Right eye, left corner. + Generated from protobuf enum <code>RIGHT_EYE_LEFT_CORNER = 24;</code> + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImageAsync()} . - - - - - + - + + LEFT_EYEBROW_UPPER_MIDPOINT + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYEBROW_UPPER_MIDPOINT + 25 + + Left eyebrow, upper midpoint. + Generated from protobuf enum <code>LEFT_EYEBROW_UPPER_MIDPOINT = 25;</code> + - - getProduct - \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProduct() - - - request - - \Google\Cloud\Vision\V1\GetProductRequest - - - - callOptions - [] - array - - - - Gets information associated with a Product. - Possible errors: - -* Returns NOT_FOUND if the Product does not exist. - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductAsync()} . - - - - - - + - + + RIGHT_EYEBROW_UPPER_MIDPOINT + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYEBROW_UPPER_MIDPOINT + 26 + + Right eyebrow, upper midpoint. + Generated from protobuf enum <code>RIGHT_EYEBROW_UPPER_MIDPOINT = 26;</code> + - - getProductSet - \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSet() - - - request - - \Google\Cloud\Vision\V1\GetProductSetRequest - + - - callOptions - [] - array - + + LEFT_EAR_TRAGION + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EAR_TRAGION + 27 + + Left ear tragion. + Generated from protobuf enum <code>LEFT_EAR_TRAGION = 27;</code> + - - Gets information associated with a ProductSet. - Possible errors: + -* Returns NOT_FOUND if the ProductSet does not exist. + + RIGHT_EAR_TRAGION + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EAR_TRAGION + 28 + + Right ear tragion. + Generated from protobuf enum <code>RIGHT_EAR_TRAGION = 28;</code> + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSetAsync()} . - - - - - - + - + + LEFT_EYE_PUPIL + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_PUPIL + 29 + + Left eye pupil. + Generated from protobuf enum <code>LEFT_EYE_PUPIL = 29;</code> + - - getReferenceImage - \Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImage() - - - request - - \Google\Cloud\Vision\V1\GetReferenceImageRequest - + - - callOptions - [] - array - + + RIGHT_EYE_PUPIL + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_PUPIL + 30 + + Right eye pupil. + Generated from protobuf enum <code>RIGHT_EYE_PUPIL = 30;</code> + - - Gets information associated with a ReferenceImage. - Possible errors: + -* Returns NOT_FOUND if the specified image does not exist. + + FOREHEAD_GLABELLA + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::FOREHEAD_GLABELLA + 31 + + Forehead glabella. + Generated from protobuf enum <code>FOREHEAD_GLABELLA = 31;</code> + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImageAsync()} . - - - - - - + - + + CHIN_GNATHION + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::CHIN_GNATHION + 32 + + Chin gnathion. + Generated from protobuf enum <code>CHIN_GNATHION = 32;</code> + - - importProductSets - \Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSets() - - - request - - \Google\Cloud\Vision\V1\ImportProductSetsRequest - + - - callOptions - [] - array - + + CHIN_LEFT_GONION + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::CHIN_LEFT_GONION + 33 + + Chin left gonion. + Generated from protobuf enum <code>CHIN_LEFT_GONION = 33;</code> + - - Asynchronous API that imports a list of reference images to specified -product sets based on a list of image information. - The [google.longrunning.Operation][google.longrunning.Operation] API can be -used to keep track of the progress and results of the request. -`Operation.metadata` contains `BatchOperationMetadata`. (progress) -`Operation.response` contains `ImportProductSetsResponse`. (results) + -The input source of this method is a csv file on Google Cloud Storage. -For the format of the csv file please see -[ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri]. + + CHIN_RIGHT_GONION + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::CHIN_RIGHT_GONION + 34 + + Chin right gonion. + Generated from protobuf enum <code>CHIN_RIGHT_GONION = 34;</code> + -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSetsAsync()} . - - - - - - + - + + LEFT_CHEEK_CENTER + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_CHEEK_CENTER + 35 + + Left cheek center. + Generated from protobuf enum <code>LEFT_CHEEK_CENTER = 35;</code> + - - listProductSets - \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSets() - - - request - - \Google\Cloud\Vision\V1\ListProductSetsRequest - + - - callOptions - [] - array - - - - Lists ProductSets in an unspecified order. - Possible errors: - -* Returns INVALID_ARGUMENT if page_size is greater than 100, or less -than 1. - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSetsAsync()} . - - - - - - - - - - - listProducts - \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProducts() - - - request - - \Google\Cloud\Vision\V1\ListProductsRequest - - - - callOptions - [] - array - - - - Lists products in an unspecified order. - Possible errors: - -* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsAsync()} . - - - - - - - - - - - listProductsInProductSet - \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSet() - - - request - - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest - - - - callOptions - [] - array - - - - Lists the Products in a ProductSet, in an unspecified order. If the -ProductSet does not exist, the products field of the response will be -empty. - Possible errors: - -* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSetAsync()} -. - - - - - - - - - - - listReferenceImages - \Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImages() - - - request - - \Google\Cloud\Vision\V1\ListReferenceImagesRequest - - - - callOptions - [] - array - - - - Lists reference images. - Possible errors: - -* Returns NOT_FOUND if the parent product does not exist. -* Returns INVALID_ARGUMENT if the page_size is greater than 100, or less -than 1. - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImagesAsync()} . - - - - - - - - - - - purgeProducts - \Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProducts() - - - request - - \Google\Cloud\Vision\V1\PurgeProductsRequest - - - - callOptions - [] - array - - - - Asynchronous API to delete all Products in a ProductSet or all Products -that are in no ProductSet. - If a Product is a member of the specified ProductSet in addition to other -ProductSets, the Product will still be deleted. - -It is recommended to not delete the specified ProductSet until after this -operation has completed. It is also recommended to not add any of the -Products involved in the batch delete to a new ProductSet while this -operation is running because those Products may still end up deleted. - -It's not possible to undo the PurgeProducts operation. Therefore, it is -recommended to keep the csv files used in ImportProductSets (if that was -how you originally built the Product Set) before starting PurgeProducts, in -case you need to re-import the data after deletion. - -If the plan is to purge all of the Products from a ProductSet and then -re-use the empty ProductSet to re-import new Products into the empty -ProductSet, you must wait until the PurgeProducts operation has finished -for that ProductSet. - -The [google.longrunning.Operation][google.longrunning.Operation] API can be -used to keep track of the progress and results of the request. -`Operation.metadata` contains `BatchOperationMetadata`. (progress) - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProductsAsync()} . - - - - - - - - - - - removeProductFromProductSet - \Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSet() - - - request - - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest - - - - callOptions - [] - array - - - - Removes a Product from the specified ProductSet. - The async variant is -{@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSetAsync()} . - - - - - - - - - - updateProduct - \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProduct() - - - request - - \Google\Cloud\Vision\V1\UpdateProductRequest - - - - callOptions - [] - array - - - - Makes changes to a Product resource. - Only the `display_name`, `description`, and `labels` fields can be updated -right now. - -If labels are updated, the change will not be reflected in queries until -the next index time. - -Possible errors: - -* Returns NOT_FOUND if the Product does not exist. -* Returns INVALID_ARGUMENT if display_name is present in update_mask but is -missing from the request or longer than 4096 characters. -* Returns INVALID_ARGUMENT if description is present in update_mask but is -longer than 4096 characters. -* Returns INVALID_ARGUMENT if product_category is present in update_mask. - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductAsync()} . - - - - - - - - - - - updateProductSet - \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSet() - - - request - - \Google\Cloud\Vision\V1\UpdateProductSetRequest - - - - callOptions - [] - array - - - - Makes changes to a ProductSet resource. - Only display_name can be updated currently. - -Possible errors: - -* Returns NOT_FOUND if the ProductSet does not exist. -* Returns INVALID_ARGUMENT if display_name is present in update_mask but -missing from the request or longer than 4096 characters. - -The async variant is {@see \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSetAsync()} . - - - - - - - - - - - addProductToProductSetAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::addProductToProductSetAsync() - - - request - - \Google\Cloud\Vision\V1\AddProductToProductSetRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - createProductAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductAsync() - - - request - - \Google\Cloud\Vision\V1\CreateProductRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - createProductSetAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::createProductSetAsync() - - - request - - \Google\Cloud\Vision\V1\CreateProductSetRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - createReferenceImageAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::createReferenceImageAsync() - - - request - - \Google\Cloud\Vision\V1\CreateReferenceImageRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - deleteProductAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductAsync() - - - request - - \Google\Cloud\Vision\V1\DeleteProductRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - deleteProductSetAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSetAsync() - - - request - - \Google\Cloud\Vision\V1\DeleteProductSetRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - deleteReferenceImageAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImageAsync() - - - request - - \Google\Cloud\Vision\V1\DeleteReferenceImageRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - getProductAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductAsync() - - - request - - \Google\Cloud\Vision\V1\GetProductRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - getProductSetAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::getProductSetAsync() - - - request - - \Google\Cloud\Vision\V1\GetProductSetRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - getReferenceImageAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::getReferenceImageAsync() - - - request - - \Google\Cloud\Vision\V1\GetReferenceImageRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - importProductSetsAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::importProductSetsAsync() - - - request - - \Google\Cloud\Vision\V1\ImportProductSetsRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - listProductSetsAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSetsAsync() - - - request - - \Google\Cloud\Vision\V1\ListProductSetsRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - listProductsAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsAsync() - - - request - - \Google\Cloud\Vision\V1\ListProductsRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - listProductsInProductSetAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSetAsync() - - - request - - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - listReferenceImagesAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImagesAsync() - - - request - - \Google\Cloud\Vision\V1\ListReferenceImagesRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - purgeProductsAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProductsAsync() - - - request - - \Google\Cloud\Vision\V1\PurgeProductsRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - removeProductFromProductSetAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSetAsync() - - - request - - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - updateProductAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductAsync() - - - request - - \Google\Cloud\Vision\V1\UpdateProductRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - updateProductSetAsync - \Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProductSetAsync() - - - request - - \Google\Cloud\Vision\V1\UpdateProductSetRequest - - - - optionalArgs - [] - array - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ColorInfo - \Google\Cloud\Vision\V1\ColorInfo - - Color information consists of RGB channels, score, and the fraction of -the image that the color occupies in the image. - Generated from protobuf message <code>google.cloud.vision.v1.ColorInfo</code> - - - - \Google\Protobuf\Internal\Message - - - - color - \Google\Cloud\Vision\V1\ColorInfo::$color - null - - RGB components of the color. - Generated from protobuf field <code>.google.type.Color color = 1;</code> - - - - - - score - \Google\Cloud\Vision\V1\ColorInfo::$score - 0.0 - - Image-specific score for this color. Value in range [0, 1]. - Generated from protobuf field <code>float score = 2;</code> - - - - - - pixel_fraction - \Google\Cloud\Vision\V1\ColorInfo::$pixel_fraction - 0.0 - - The fraction of pixels the color occupies in the image. - Value in range [0, 1]. - -Generated from protobuf field <code>float pixel_fraction = 3;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\ColorInfo::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getColor - \Google\Cloud\Vision\V1\ColorInfo::getColor() - - - RGB components of the color. - Generated from protobuf field <code>.google.type.Color color = 1;</code> - - - - - - - hasColor - \Google\Cloud\Vision\V1\ColorInfo::hasColor() - - - - - - - - - - clearColor - \Google\Cloud\Vision\V1\ColorInfo::clearColor() - - - - - - - - - - setColor - \Google\Cloud\Vision\V1\ColorInfo::setColor() - - - var - - \Google\Type\Color - - - - RGB components of the color. - Generated from protobuf field <code>.google.type.Color color = 1;</code> - - - - - - - - getScore - \Google\Cloud\Vision\V1\ColorInfo::getScore() - - - Image-specific score for this color. Value in range [0, 1]. - Generated from protobuf field <code>float score = 2;</code> - - - - - - - setScore - \Google\Cloud\Vision\V1\ColorInfo::setScore() - - - var - - float - - - - Image-specific score for this color. Value in range [0, 1]. - Generated from protobuf field <code>float score = 2;</code> - - - - - - - - getPixelFraction - \Google\Cloud\Vision\V1\ColorInfo::getPixelFraction() - - - The fraction of pixels the color occupies in the image. - Value in range [0, 1]. - -Generated from protobuf field <code>float pixel_fraction = 3;</code> - - - - - - - setPixelFraction - \Google\Cloud\Vision\V1\ColorInfo::setPixelFraction() - - - var - - float - - - - The fraction of pixels the color occupies in the image. - Value in range [0, 1]. - -Generated from protobuf field <code>float pixel_fraction = 3;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - CreateProductRequest - \Google\Cloud\Vision\V1\CreateProductRequest - - Request message for the `CreateProduct` method. - Generated from protobuf message <code>google.cloud.vision.v1.CreateProductRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - parent - \Google\Cloud\Vision\V1\CreateProductRequest::$parent - '' - - Required. The project in which the Product should be created. - Format is -`projects/PROJECT_ID/locations/LOC_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - product - \Google\Cloud\Vision\V1\CreateProductRequest::$product - null - - Required. The product to create. - Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - product_id - \Google\Cloud\Vision\V1\CreateProductRequest::$product_id - '' - - A user-supplied resource id for this Product. If set, the server will -attempt to use this value as the resource id. If it is already in use, an -error is returned with code ALREADY_EXISTS. Must be at most 128 characters -long. It cannot contain the character `/`. - Generated from protobuf field <code>string product_id = 3;</code> - - - - - - - build - \Google\Cloud\Vision\V1\CreateProductRequest::build() - - - parent - - string - - - - product - - \Google\Cloud\Vision\V1\Product - - - - productId - - string - - - - - - - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\CreateProductRequest::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getParent - \Google\Cloud\Vision\V1\CreateProductRequest::getParent() - - - Required. The project in which the Product should be created. - Format is -`projects/PROJECT_ID/locations/LOC_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - setParent - \Google\Cloud\Vision\V1\CreateProductRequest::setParent() - - - var - - string - - - - Required. The project in which the Product should be created. - Format is -`projects/PROJECT_ID/locations/LOC_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - getProduct - \Google\Cloud\Vision\V1\CreateProductRequest::getProduct() - - - Required. The product to create. - Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - - hasProduct - \Google\Cloud\Vision\V1\CreateProductRequest::hasProduct() - - - - - - - - - - clearProduct - \Google\Cloud\Vision\V1\CreateProductRequest::clearProduct() - - - - - - - - - - setProduct - \Google\Cloud\Vision\V1\CreateProductRequest::setProduct() - - - var - - \Google\Cloud\Vision\V1\Product - - - - Required. The product to create. - Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - - - getProductId - \Google\Cloud\Vision\V1\CreateProductRequest::getProductId() - - - A user-supplied resource id for this Product. If set, the server will -attempt to use this value as the resource id. If it is already in use, an -error is returned with code ALREADY_EXISTS. Must be at most 128 characters -long. It cannot contain the character `/`. - Generated from protobuf field <code>string product_id = 3;</code> - - - - - - - setProductId - \Google\Cloud\Vision\V1\CreateProductRequest::setProductId() - - - var - - string - - - - A user-supplied resource id for this Product. If set, the server will -attempt to use this value as the resource id. If it is already in use, an -error is returned with code ALREADY_EXISTS. Must be at most 128 characters -long. It cannot contain the character `/`. - Generated from protobuf field <code>string product_id = 3;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - CreateProductSetRequest - \Google\Cloud\Vision\V1\CreateProductSetRequest - - Request message for the `CreateProductSet` method. - Generated from protobuf message <code>google.cloud.vision.v1.CreateProductSetRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - parent - \Google\Cloud\Vision\V1\CreateProductSetRequest::$parent - '' - - Required. The project in which the ProductSet should be created. - Format is `projects/PROJECT_ID/locations/LOC_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - product_set - \Google\Cloud\Vision\V1\CreateProductSetRequest::$product_set - null - - Required. The ProductSet to create. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - product_set_id - \Google\Cloud\Vision\V1\CreateProductSetRequest::$product_set_id - '' - - A user-supplied resource id for this ProductSet. If set, the server will -attempt to use this value as the resource id. If it is already in use, an -error is returned with code ALREADY_EXISTS. Must be at most 128 characters -long. It cannot contain the character `/`. - Generated from protobuf field <code>string product_set_id = 3;</code> - - - - - - - build - \Google\Cloud\Vision\V1\CreateProductSetRequest::build() - - - parent - - string - - - - productSet - - \Google\Cloud\Vision\V1\ProductSet - - - - productSetId - - string - - - - - - - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\CreateProductSetRequest::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getParent - \Google\Cloud\Vision\V1\CreateProductSetRequest::getParent() - - - Required. The project in which the ProductSet should be created. - Format is `projects/PROJECT_ID/locations/LOC_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - setParent - \Google\Cloud\Vision\V1\CreateProductSetRequest::setParent() - - - var - - string - - - - Required. The project in which the ProductSet should be created. - Format is `projects/PROJECT_ID/locations/LOC_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - getProductSet - \Google\Cloud\Vision\V1\CreateProductSetRequest::getProductSet() - - - Required. The ProductSet to create. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - - hasProductSet - \Google\Cloud\Vision\V1\CreateProductSetRequest::hasProductSet() - - - - - - - - - - clearProductSet - \Google\Cloud\Vision\V1\CreateProductSetRequest::clearProductSet() - - - - - - - - - - setProductSet - \Google\Cloud\Vision\V1\CreateProductSetRequest::setProductSet() - - - var - - \Google\Cloud\Vision\V1\ProductSet - - - - Required. The ProductSet to create. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - - - getProductSetId - \Google\Cloud\Vision\V1\CreateProductSetRequest::getProductSetId() - - - A user-supplied resource id for this ProductSet. If set, the server will -attempt to use this value as the resource id. If it is already in use, an -error is returned with code ALREADY_EXISTS. Must be at most 128 characters -long. It cannot contain the character `/`. - Generated from protobuf field <code>string product_set_id = 3;</code> - - - - - - - setProductSetId - \Google\Cloud\Vision\V1\CreateProductSetRequest::setProductSetId() - - - var - - string - - - - A user-supplied resource id for this ProductSet. If set, the server will -attempt to use this value as the resource id. If it is already in use, an -error is returned with code ALREADY_EXISTS. Must be at most 128 characters -long. It cannot contain the character `/`. - Generated from protobuf field <code>string product_set_id = 3;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - CreateReferenceImageRequest - \Google\Cloud\Vision\V1\CreateReferenceImageRequest - - Request message for the `CreateReferenceImage` method. - Generated from protobuf message <code>google.cloud.vision.v1.CreateReferenceImageRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - parent - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::$parent - '' - - Required. Resource name of the product in which to create the reference -image. - Format is -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - reference_image - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::$reference_image - null - - Required. The reference image to create. - If an image ID is specified, it is ignored. - -Generated from protobuf field <code>.google.cloud.vision.v1.ReferenceImage reference_image = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - reference_image_id - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::$reference_image_id - '' - - A user-supplied resource id for the ReferenceImage to be added. If set, -the server will attempt to use this value as the resource id. If it is -already in use, an error is returned with code ALREADY_EXISTS. Must be at -most 128 characters long. It cannot contain the character `/`. - Generated from protobuf field <code>string reference_image_id = 3;</code> - - - - - - - build - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::build() - - - parent - - string - - - - referenceImage - - \Google\Cloud\Vision\V1\ReferenceImage - - - - referenceImageId - - string - - - - - - - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getParent - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::getParent() - - - Required. Resource name of the product in which to create the reference -image. - Format is -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - setParent - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::setParent() - - - var - - string - - - - Required. Resource name of the product in which to create the reference -image. - Format is -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - getReferenceImage - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::getReferenceImage() - - - Required. The reference image to create. - If an image ID is specified, it is ignored. - -Generated from protobuf field <code>.google.cloud.vision.v1.ReferenceImage reference_image = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - - hasReferenceImage - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::hasReferenceImage() - - - - - - - - - - clearReferenceImage - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::clearReferenceImage() - - - - - - - - - - setReferenceImage - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::setReferenceImage() - - - var - - \Google\Cloud\Vision\V1\ReferenceImage - - - - Required. The reference image to create. - If an image ID is specified, it is ignored. - -Generated from protobuf field <code>.google.cloud.vision.v1.ReferenceImage reference_image = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - - - getReferenceImageId - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::getReferenceImageId() - - - A user-supplied resource id for the ReferenceImage to be added. If set, -the server will attempt to use this value as the resource id. If it is -already in use, an error is returned with code ALREADY_EXISTS. Must be at -most 128 characters long. It cannot contain the character `/`. - Generated from protobuf field <code>string reference_image_id = 3;</code> - - - - - - - setReferenceImageId - \Google\Cloud\Vision\V1\CreateReferenceImageRequest::setReferenceImageId() - - - var - - string - - - - A user-supplied resource id for the ReferenceImage to be added. If set, -the server will attempt to use this value as the resource id. If it is -already in use, an error is returned with code ALREADY_EXISTS. Must be at -most 128 characters long. It cannot contain the character `/`. - Generated from protobuf field <code>string reference_image_id = 3;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - CropHint - \Google\Cloud\Vision\V1\CropHint - - Single crop hint that is used to generate a new crop when serving an image. - Generated from protobuf message <code>google.cloud.vision.v1.CropHint</code> - - - - \Google\Protobuf\Internal\Message - - - - bounding_poly - \Google\Cloud\Vision\V1\CropHint::$bounding_poly - null - - The bounding polygon for the crop region. The coordinates of the bounding -box are in the original image's scale. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> - - - - - - confidence - \Google\Cloud\Vision\V1\CropHint::$confidence - 0.0 - - Confidence of this being a salient region. Range [0, 1]. - Generated from protobuf field <code>float confidence = 2;</code> - - - - - - importance_fraction - \Google\Cloud\Vision\V1\CropHint::$importance_fraction - 0.0 - - Fraction of importance of this salient region with respect to the original -image. - Generated from protobuf field <code>float importance_fraction = 3;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\CropHint::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getBoundingPoly - \Google\Cloud\Vision\V1\CropHint::getBoundingPoly() - - - The bounding polygon for the crop region. The coordinates of the bounding -box are in the original image's scale. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> - - - - - - - hasBoundingPoly - \Google\Cloud\Vision\V1\CropHint::hasBoundingPoly() - - - - - - - - - - clearBoundingPoly - \Google\Cloud\Vision\V1\CropHint::clearBoundingPoly() - - - - - - - - - - setBoundingPoly - \Google\Cloud\Vision\V1\CropHint::setBoundingPoly() - - - var - - \Google\Cloud\Vision\V1\BoundingPoly - - - - The bounding polygon for the crop region. The coordinates of the bounding -box are in the original image's scale. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> - - - - - - - - getConfidence - \Google\Cloud\Vision\V1\CropHint::getConfidence() - - - Confidence of this being a salient region. Range [0, 1]. - Generated from protobuf field <code>float confidence = 2;</code> - - - - - - - setConfidence - \Google\Cloud\Vision\V1\CropHint::setConfidence() - - - var - - float - - - - Confidence of this being a salient region. Range [0, 1]. - Generated from protobuf field <code>float confidence = 2;</code> - - - - - - - - getImportanceFraction - \Google\Cloud\Vision\V1\CropHint::getImportanceFraction() - - - Fraction of importance of this salient region with respect to the original -image. - Generated from protobuf field <code>float importance_fraction = 3;</code> - - - - - - - setImportanceFraction - \Google\Cloud\Vision\V1\CropHint::setImportanceFraction() - - - var - - float - - - - Fraction of importance of this salient region with respect to the original -image. - Generated from protobuf field <code>float importance_fraction = 3;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - CropHintsAnnotation - \Google\Cloud\Vision\V1\CropHintsAnnotation - - Set of crop hints that are used to generate new crops when serving images. - Generated from protobuf message <code>google.cloud.vision.v1.CropHintsAnnotation</code> - - - - \Google\Protobuf\Internal\Message - - - - crop_hints - \Google\Cloud\Vision\V1\CropHintsAnnotation::$crop_hints - - - Crop hint results. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.CropHint crop_hints = 1;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\CropHintsAnnotation::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getCropHints - \Google\Cloud\Vision\V1\CropHintsAnnotation::getCropHints() - - - Crop hint results. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.CropHint crop_hints = 1;</code> - - - - - - - setCropHints - \Google\Cloud\Vision\V1\CropHintsAnnotation::setCropHints() - - - var - - \Google\Cloud\Vision\V1\CropHint[]|\Google\Protobuf\Internal\RepeatedField - - - - Crop hint results. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.CropHint crop_hints = 1;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - CropHintsParams - \Google\Cloud\Vision\V1\CropHintsParams - - Parameters for crop hints annotation request. - Generated from protobuf message <code>google.cloud.vision.v1.CropHintsParams</code> - - - - \Google\Protobuf\Internal\Message - - - - aspect_ratios - \Google\Cloud\Vision\V1\CropHintsParams::$aspect_ratios - - - Aspect ratios in floats, representing the ratio of the width to the height -of the image. For example, if the desired aspect ratio is 4/3, the -corresponding float value should be 1.33333. If not specified, the -best possible crop is returned. The number of provided aspect ratios is -limited to a maximum of 16; any aspect ratios provided after the 16th are -ignored. - Generated from protobuf field <code>repeated float aspect_ratios = 1;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\CropHintsParams::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getAspectRatios - \Google\Cloud\Vision\V1\CropHintsParams::getAspectRatios() - - - Aspect ratios in floats, representing the ratio of the width to the height -of the image. For example, if the desired aspect ratio is 4/3, the -corresponding float value should be 1.33333. If not specified, the -best possible crop is returned. The number of provided aspect ratios is -limited to a maximum of 16; any aspect ratios provided after the 16th are -ignored. - Generated from protobuf field <code>repeated float aspect_ratios = 1;</code> - - - - - - - setAspectRatios - \Google\Cloud\Vision\V1\CropHintsParams::setAspectRatios() - - - var - - float[]|\Google\Protobuf\Internal\RepeatedField - - - - Aspect ratios in floats, representing the ratio of the width to the height -of the image. For example, if the desired aspect ratio is 4/3, the -corresponding float value should be 1.33333. If not specified, the -best possible crop is returned. The number of provided aspect ratios is -limited to a maximum of 16; any aspect ratios provided after the 16th are -ignored. - Generated from protobuf field <code>repeated float aspect_ratios = 1;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - DeleteProductRequest - \Google\Cloud\Vision\V1\DeleteProductRequest - - Request message for the `DeleteProduct` method. - Generated from protobuf message <code>google.cloud.vision.v1.DeleteProductRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - name - \Google\Cloud\Vision\V1\DeleteProductRequest::$name - '' - - Required. Resource name of product to delete. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - build - \Google\Cloud\Vision\V1\DeleteProductRequest::build() - - - name - - string - - - - - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\DeleteProductRequest::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getName - \Google\Cloud\Vision\V1\DeleteProductRequest::getName() - - - Required. Resource name of product to delete. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - setName - \Google\Cloud\Vision\V1\DeleteProductRequest::setName() - - - var - - string - - - - Required. Resource name of product to delete. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - DeleteProductSetRequest - \Google\Cloud\Vision\V1\DeleteProductSetRequest - - Request message for the `DeleteProductSet` method. - Generated from protobuf message <code>google.cloud.vision.v1.DeleteProductSetRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - name - \Google\Cloud\Vision\V1\DeleteProductSetRequest::$name - '' - - Required. Resource name of the ProductSet to delete. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - build - \Google\Cloud\Vision\V1\DeleteProductSetRequest::build() - - - name - - string - - - - - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\DeleteProductSetRequest::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getName - \Google\Cloud\Vision\V1\DeleteProductSetRequest::getName() - - - Required. Resource name of the ProductSet to delete. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - setName - \Google\Cloud\Vision\V1\DeleteProductSetRequest::setName() - - - var - - string - - - - Required. Resource name of the ProductSet to delete. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - DeleteReferenceImageRequest - \Google\Cloud\Vision\V1\DeleteReferenceImageRequest - - Request message for the `DeleteReferenceImage` method. - Generated from protobuf message <code>google.cloud.vision.v1.DeleteReferenceImageRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - name - \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::$name - '' - - Required. The resource name of the reference image to delete. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - build - \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::build() - - - name - - string - - - - - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getName - \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::getName() - - - Required. The resource name of the reference image to delete. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - setName - \Google\Cloud\Vision\V1\DeleteReferenceImageRequest::setName() - - - var - - string - - - - Required. The resource name of the reference image to delete. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - DominantColorsAnnotation - \Google\Cloud\Vision\V1\DominantColorsAnnotation - - Set of dominant colors and their corresponding scores. - Generated from protobuf message <code>google.cloud.vision.v1.DominantColorsAnnotation</code> - - - - \Google\Protobuf\Internal\Message - - - - colors - \Google\Cloud\Vision\V1\DominantColorsAnnotation::$colors - - - RGB color values with their score and pixel fraction. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ColorInfo colors = 1;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\DominantColorsAnnotation::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getColors - \Google\Cloud\Vision\V1\DominantColorsAnnotation::getColors() - - - RGB color values with their score and pixel fraction. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ColorInfo colors = 1;</code> - - - - - - - setColors - \Google\Cloud\Vision\V1\DominantColorsAnnotation::setColors() - - - var - - \Google\Cloud\Vision\V1\ColorInfo[]|\Google\Protobuf\Internal\RepeatedField - - - - RGB color values with their score and pixel fraction. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ColorInfo colors = 1;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - EntityAnnotation - \Google\Cloud\Vision\V1\EntityAnnotation - - Set of detected entity features. - Generated from protobuf message <code>google.cloud.vision.v1.EntityAnnotation</code> - - - - \Google\Protobuf\Internal\Message - - - - mid - \Google\Cloud\Vision\V1\EntityAnnotation::$mid - '' - - Opaque entity ID. Some IDs may be available in -[Google Knowledge Graph Search -API](https://developers.google.com/knowledge-graph/). - Generated from protobuf field <code>string mid = 1;</code> - - - - - - locale - \Google\Cloud\Vision\V1\EntityAnnotation::$locale - '' - - The language code for the locale in which the entity textual -`description` is expressed. - Generated from protobuf field <code>string locale = 2;</code> - - - - - - description - \Google\Cloud\Vision\V1\EntityAnnotation::$description - '' - - Entity textual description, expressed in its `locale` language. - Generated from protobuf field <code>string description = 3;</code> - - - - - - score - \Google\Cloud\Vision\V1\EntityAnnotation::$score - 0.0 - - Overall score of the result. Range [0, 1]. - Generated from protobuf field <code>float score = 4;</code> - - - - - - confidence - \Google\Cloud\Vision\V1\EntityAnnotation::$confidence - 0.0 - - **Deprecated. Use `score` instead.** -The accuracy of the entity detection in an image. - For example, for an image in which the "Eiffel Tower" entity is detected, -this field represents the confidence that there is a tower in the query -image. Range [0, 1]. - -Generated from protobuf field <code>float confidence = 5 [deprecated = true];</code> - - - - - - - topicality - \Google\Cloud\Vision\V1\EntityAnnotation::$topicality - 0.0 - - The relevancy of the ICA (Image Content Annotation) label to the -image. For example, the relevancy of "tower" is likely higher to an image -containing the detected "Eiffel Tower" than to an image containing a -detected distant towering building, even though the confidence that -there is a tower in each image may be the same. Range [0, 1]. - Generated from protobuf field <code>float topicality = 6;</code> - - - - - - bounding_poly - \Google\Cloud\Vision\V1\EntityAnnotation::$bounding_poly - null - - Image region to which this entity belongs. Not produced -for `LABEL_DETECTION` features. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;</code> - - - - - - locations - \Google\Cloud\Vision\V1\EntityAnnotation::$locations - - - The location information for the detected entity. Multiple -`LocationInfo` elements can be present because one location may -indicate the location of the scene in the image, and another location -may indicate the location of the place where the image was taken. - Location information is usually present for landmarks. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocationInfo locations = 8;</code> - - - - - - properties - \Google\Cloud\Vision\V1\EntityAnnotation::$properties - - - Some entities may have optional user-supplied `Property` (name/value) -fields, such a score or string that qualifies the entity. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Property properties = 9;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\EntityAnnotation::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getMid - \Google\Cloud\Vision\V1\EntityAnnotation::getMid() - - - Opaque entity ID. Some IDs may be available in -[Google Knowledge Graph Search -API](https://developers.google.com/knowledge-graph/). - Generated from protobuf field <code>string mid = 1;</code> - - - - - - - setMid - \Google\Cloud\Vision\V1\EntityAnnotation::setMid() - - - var - - string - - - - Opaque entity ID. Some IDs may be available in -[Google Knowledge Graph Search -API](https://developers.google.com/knowledge-graph/). - Generated from protobuf field <code>string mid = 1;</code> - - - - - - - - getLocale - \Google\Cloud\Vision\V1\EntityAnnotation::getLocale() - - - The language code for the locale in which the entity textual -`description` is expressed. - Generated from protobuf field <code>string locale = 2;</code> - - - - - - - setLocale - \Google\Cloud\Vision\V1\EntityAnnotation::setLocale() - - - var - - string - - - - The language code for the locale in which the entity textual -`description` is expressed. - Generated from protobuf field <code>string locale = 2;</code> - - - - - - - - getDescription - \Google\Cloud\Vision\V1\EntityAnnotation::getDescription() - - - Entity textual description, expressed in its `locale` language. - Generated from protobuf field <code>string description = 3;</code> - - - - - - - setDescription - \Google\Cloud\Vision\V1\EntityAnnotation::setDescription() - - - var - - string - - - - Entity textual description, expressed in its `locale` language. - Generated from protobuf field <code>string description = 3;</code> - - - - - - - - getScore - \Google\Cloud\Vision\V1\EntityAnnotation::getScore() - - - Overall score of the result. Range [0, 1]. - Generated from protobuf field <code>float score = 4;</code> - - - - - - - setScore - \Google\Cloud\Vision\V1\EntityAnnotation::setScore() - - - var - - float - - - - Overall score of the result. Range [0, 1]. - Generated from protobuf field <code>float score = 4;</code> - - - - - - - - getConfidence - \Google\Cloud\Vision\V1\EntityAnnotation::getConfidence() - - - **Deprecated. Use `score` instead.** -The accuracy of the entity detection in an image. - For example, for an image in which the "Eiffel Tower" entity is detected, -this field represents the confidence that there is a tower in the query -image. Range [0, 1]. - -Generated from protobuf field <code>float confidence = 5 [deprecated = true];</code> - - - - - - - - setConfidence - \Google\Cloud\Vision\V1\EntityAnnotation::setConfidence() - - - var - - float - - - - **Deprecated. Use `score` instead.** -The accuracy of the entity detection in an image. - For example, for an image in which the "Eiffel Tower" entity is detected, -this field represents the confidence that there is a tower in the query -image. Range [0, 1]. - -Generated from protobuf field <code>float confidence = 5 [deprecated = true];</code> - - - - - - - - - getTopicality - \Google\Cloud\Vision\V1\EntityAnnotation::getTopicality() - - - The relevancy of the ICA (Image Content Annotation) label to the -image. For example, the relevancy of "tower" is likely higher to an image -containing the detected "Eiffel Tower" than to an image containing a -detected distant towering building, even though the confidence that -there is a tower in each image may be the same. Range [0, 1]. - Generated from protobuf field <code>float topicality = 6;</code> - - - - - - - setTopicality - \Google\Cloud\Vision\V1\EntityAnnotation::setTopicality() - - - var - - float - - - - The relevancy of the ICA (Image Content Annotation) label to the -image. For example, the relevancy of "tower" is likely higher to an image -containing the detected "Eiffel Tower" than to an image containing a -detected distant towering building, even though the confidence that -there is a tower in each image may be the same. Range [0, 1]. - Generated from protobuf field <code>float topicality = 6;</code> - - - - - - - - getBoundingPoly - \Google\Cloud\Vision\V1\EntityAnnotation::getBoundingPoly() - - - Image region to which this entity belongs. Not produced -for `LABEL_DETECTION` features. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;</code> - - - - - - - hasBoundingPoly - \Google\Cloud\Vision\V1\EntityAnnotation::hasBoundingPoly() - - - - - - - - - - clearBoundingPoly - \Google\Cloud\Vision\V1\EntityAnnotation::clearBoundingPoly() - - - - - - - - - - setBoundingPoly - \Google\Cloud\Vision\V1\EntityAnnotation::setBoundingPoly() - - - var - - \Google\Cloud\Vision\V1\BoundingPoly - - - - Image region to which this entity belongs. Not produced -for `LABEL_DETECTION` features. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;</code> - - - - - - - - getLocations - \Google\Cloud\Vision\V1\EntityAnnotation::getLocations() - - - The location information for the detected entity. Multiple -`LocationInfo` elements can be present because one location may -indicate the location of the scene in the image, and another location -may indicate the location of the place where the image was taken. - Location information is usually present for landmarks. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocationInfo locations = 8;</code> - - - - - - - setLocations - \Google\Cloud\Vision\V1\EntityAnnotation::setLocations() - - - var - - \Google\Cloud\Vision\V1\LocationInfo[]|\Google\Protobuf\Internal\RepeatedField - - - - The location information for the detected entity. Multiple -`LocationInfo` elements can be present because one location may -indicate the location of the scene in the image, and another location -may indicate the location of the place where the image was taken. - Location information is usually present for landmarks. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.LocationInfo locations = 8;</code> - - - - - - - - getProperties - \Google\Cloud\Vision\V1\EntityAnnotation::getProperties() - - - Some entities may have optional user-supplied `Property` (name/value) -fields, such a score or string that qualifies the entity. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Property properties = 9;</code> - - - - - - - setProperties - \Google\Cloud\Vision\V1\EntityAnnotation::setProperties() - - - var - - \Google\Cloud\Vision\V1\Property[]|\Google\Protobuf\Internal\RepeatedField - - - - Some entities may have optional user-supplied `Property` (name/value) -fields, such a score or string that qualifies the entity. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Property properties = 9;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Type - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type - - Face landmark (feature) type. - Left and right are defined from the vantage of the viewer of the image -without considering mirror projections typical of photos. So, `LEFT_EYE`, -typically, is the person's right eye. - -Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type</code> - - - - - - - UNKNOWN_LANDMARK - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::UNKNOWN_LANDMARK - 0 - - Unknown face landmark detected. Should not be filled. - Generated from protobuf enum <code>UNKNOWN_LANDMARK = 0;</code> - - - - - - LEFT_EYE - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE - 1 - - Left eye. - Generated from protobuf enum <code>LEFT_EYE = 1;</code> - - - - - - RIGHT_EYE - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE - 2 - - Right eye. - Generated from protobuf enum <code>RIGHT_EYE = 2;</code> - - - - - - LEFT_OF_LEFT_EYEBROW - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_OF_LEFT_EYEBROW - 3 - - Left of left eyebrow. - Generated from protobuf enum <code>LEFT_OF_LEFT_EYEBROW = 3;</code> - - - - - - RIGHT_OF_LEFT_EYEBROW - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_OF_LEFT_EYEBROW - 4 - - Right of left eyebrow. - Generated from protobuf enum <code>RIGHT_OF_LEFT_EYEBROW = 4;</code> - - - - - - LEFT_OF_RIGHT_EYEBROW - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_OF_RIGHT_EYEBROW - 5 - - Left of right eyebrow. - Generated from protobuf enum <code>LEFT_OF_RIGHT_EYEBROW = 5;</code> - - - - - - RIGHT_OF_RIGHT_EYEBROW - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_OF_RIGHT_EYEBROW - 6 - - Right of right eyebrow. - Generated from protobuf enum <code>RIGHT_OF_RIGHT_EYEBROW = 6;</code> - - - - - - MIDPOINT_BETWEEN_EYES - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::MIDPOINT_BETWEEN_EYES - 7 - - Midpoint between eyes. - Generated from protobuf enum <code>MIDPOINT_BETWEEN_EYES = 7;</code> - - - - - - NOSE_TIP - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::NOSE_TIP - 8 - - Nose tip. - Generated from protobuf enum <code>NOSE_TIP = 8;</code> - - - - - - UPPER_LIP - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::UPPER_LIP - 9 - - Upper lip. - Generated from protobuf enum <code>UPPER_LIP = 9;</code> - - - - - - LOWER_LIP - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LOWER_LIP - 10 - - Lower lip. - Generated from protobuf enum <code>LOWER_LIP = 10;</code> - - - - - - MOUTH_LEFT - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::MOUTH_LEFT - 11 - - Mouth left. - Generated from protobuf enum <code>MOUTH_LEFT = 11;</code> - - - - - - MOUTH_RIGHT - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::MOUTH_RIGHT - 12 - - Mouth right. - Generated from protobuf enum <code>MOUTH_RIGHT = 12;</code> - - - - - - MOUTH_CENTER - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::MOUTH_CENTER - 13 - - Mouth center. - Generated from protobuf enum <code>MOUTH_CENTER = 13;</code> - - - - - - NOSE_BOTTOM_RIGHT - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::NOSE_BOTTOM_RIGHT - 14 - - Nose, bottom right. - Generated from protobuf enum <code>NOSE_BOTTOM_RIGHT = 14;</code> - - - - - - NOSE_BOTTOM_LEFT - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::NOSE_BOTTOM_LEFT - 15 - - Nose, bottom left. - Generated from protobuf enum <code>NOSE_BOTTOM_LEFT = 15;</code> - - - - - - NOSE_BOTTOM_CENTER - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::NOSE_BOTTOM_CENTER - 16 - - Nose, bottom center. - Generated from protobuf enum <code>NOSE_BOTTOM_CENTER = 16;</code> - - - - - - LEFT_EYE_TOP_BOUNDARY - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_TOP_BOUNDARY - 17 - - Left eye, top boundary. - Generated from protobuf enum <code>LEFT_EYE_TOP_BOUNDARY = 17;</code> - - - - - - LEFT_EYE_RIGHT_CORNER - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_RIGHT_CORNER - 18 - - Left eye, right corner. - Generated from protobuf enum <code>LEFT_EYE_RIGHT_CORNER = 18;</code> - - - - - - LEFT_EYE_BOTTOM_BOUNDARY - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_BOTTOM_BOUNDARY - 19 - - Left eye, bottom boundary. - Generated from protobuf enum <code>LEFT_EYE_BOTTOM_BOUNDARY = 19;</code> - - - - - - LEFT_EYE_LEFT_CORNER - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_LEFT_CORNER - 20 - - Left eye, left corner. - Generated from protobuf enum <code>LEFT_EYE_LEFT_CORNER = 20;</code> - - - - - - RIGHT_EYE_TOP_BOUNDARY - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_TOP_BOUNDARY - 21 - - Right eye, top boundary. - Generated from protobuf enum <code>RIGHT_EYE_TOP_BOUNDARY = 21;</code> - - - - - - RIGHT_EYE_RIGHT_CORNER - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_RIGHT_CORNER - 22 - - Right eye, right corner. - Generated from protobuf enum <code>RIGHT_EYE_RIGHT_CORNER = 22;</code> - - - - - - RIGHT_EYE_BOTTOM_BOUNDARY - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_BOTTOM_BOUNDARY - 23 - - Right eye, bottom boundary. - Generated from protobuf enum <code>RIGHT_EYE_BOTTOM_BOUNDARY = 23;</code> - - - - - - RIGHT_EYE_LEFT_CORNER - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_LEFT_CORNER - 24 - - Right eye, left corner. - Generated from protobuf enum <code>RIGHT_EYE_LEFT_CORNER = 24;</code> - - - - - - LEFT_EYEBROW_UPPER_MIDPOINT - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYEBROW_UPPER_MIDPOINT - 25 - - Left eyebrow, upper midpoint. - Generated from protobuf enum <code>LEFT_EYEBROW_UPPER_MIDPOINT = 25;</code> - - - - - - RIGHT_EYEBROW_UPPER_MIDPOINT - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYEBROW_UPPER_MIDPOINT - 26 - - Right eyebrow, upper midpoint. - Generated from protobuf enum <code>RIGHT_EYEBROW_UPPER_MIDPOINT = 26;</code> - - - - - - LEFT_EAR_TRAGION - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EAR_TRAGION - 27 - - Left ear tragion. - Generated from protobuf enum <code>LEFT_EAR_TRAGION = 27;</code> - - - - - - RIGHT_EAR_TRAGION - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EAR_TRAGION - 28 - - Right ear tragion. - Generated from protobuf enum <code>RIGHT_EAR_TRAGION = 28;</code> - - - - - - LEFT_EYE_PUPIL - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_EYE_PUPIL - 29 - - Left eye pupil. - Generated from protobuf enum <code>LEFT_EYE_PUPIL = 29;</code> - - - - - - RIGHT_EYE_PUPIL - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_EYE_PUPIL - 30 - - Right eye pupil. - Generated from protobuf enum <code>RIGHT_EYE_PUPIL = 30;</code> - - - - - - FOREHEAD_GLABELLA - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::FOREHEAD_GLABELLA - 31 - - Forehead glabella. - Generated from protobuf enum <code>FOREHEAD_GLABELLA = 31;</code> - - - - - - CHIN_GNATHION - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::CHIN_GNATHION - 32 - - Chin gnathion. - Generated from protobuf enum <code>CHIN_GNATHION = 32;</code> - - - - - - CHIN_LEFT_GONION - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::CHIN_LEFT_GONION - 33 - - Chin left gonion. - Generated from protobuf enum <code>CHIN_LEFT_GONION = 33;</code> - - - - - - CHIN_RIGHT_GONION - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::CHIN_RIGHT_GONION - 34 - - Chin right gonion. - Generated from protobuf enum <code>CHIN_RIGHT_GONION = 34;</code> - - - - - - LEFT_CHEEK_CENTER - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::LEFT_CHEEK_CENTER - 35 - - Left cheek center. - Generated from protobuf enum <code>LEFT_CHEEK_CENTER = 35;</code> - - - - - - RIGHT_CHEEK_CENTER - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_CHEEK_CENTER - 36 - - Right cheek center. - Generated from protobuf enum <code>RIGHT_CHEEK_CENTER = 36;</code> - - - - - - - valueToName - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::$valueToName - [self::UNKNOWN_LANDMARK => 'UNKNOWN_LANDMARK', self::LEFT_EYE => 'LEFT_EYE', self::RIGHT_EYE => 'RIGHT_EYE', self::LEFT_OF_LEFT_EYEBROW => 'LEFT_OF_LEFT_EYEBROW', self::RIGHT_OF_LEFT_EYEBROW => 'RIGHT_OF_LEFT_EYEBROW', self::LEFT_OF_RIGHT_EYEBROW => 'LEFT_OF_RIGHT_EYEBROW', self::RIGHT_OF_RIGHT_EYEBROW => 'RIGHT_OF_RIGHT_EYEBROW', self::MIDPOINT_BETWEEN_EYES => 'MIDPOINT_BETWEEN_EYES', self::NOSE_TIP => 'NOSE_TIP', self::UPPER_LIP => 'UPPER_LIP', self::LOWER_LIP => 'LOWER_LIP', self::MOUTH_LEFT => 'MOUTH_LEFT', self::MOUTH_RIGHT => 'MOUTH_RIGHT', self::MOUTH_CENTER => 'MOUTH_CENTER', self::NOSE_BOTTOM_RIGHT => 'NOSE_BOTTOM_RIGHT', self::NOSE_BOTTOM_LEFT => 'NOSE_BOTTOM_LEFT', self::NOSE_BOTTOM_CENTER => 'NOSE_BOTTOM_CENTER', self::LEFT_EYE_TOP_BOUNDARY => 'LEFT_EYE_TOP_BOUNDARY', self::LEFT_EYE_RIGHT_CORNER => 'LEFT_EYE_RIGHT_CORNER', self::LEFT_EYE_BOTTOM_BOUNDARY => 'LEFT_EYE_BOTTOM_BOUNDARY', self::LEFT_EYE_LEFT_CORNER => 'LEFT_EYE_LEFT_CORNER', self::RIGHT_EYE_TOP_BOUNDARY => 'RIGHT_EYE_TOP_BOUNDARY', self::RIGHT_EYE_RIGHT_CORNER => 'RIGHT_EYE_RIGHT_CORNER', self::RIGHT_EYE_BOTTOM_BOUNDARY => 'RIGHT_EYE_BOTTOM_BOUNDARY', self::RIGHT_EYE_LEFT_CORNER => 'RIGHT_EYE_LEFT_CORNER', self::LEFT_EYEBROW_UPPER_MIDPOINT => 'LEFT_EYEBROW_UPPER_MIDPOINT', self::RIGHT_EYEBROW_UPPER_MIDPOINT => 'RIGHT_EYEBROW_UPPER_MIDPOINT', self::LEFT_EAR_TRAGION => 'LEFT_EAR_TRAGION', self::RIGHT_EAR_TRAGION => 'RIGHT_EAR_TRAGION', self::LEFT_EYE_PUPIL => 'LEFT_EYE_PUPIL', self::RIGHT_EYE_PUPIL => 'RIGHT_EYE_PUPIL', self::FOREHEAD_GLABELLA => 'FOREHEAD_GLABELLA', self::CHIN_GNATHION => 'CHIN_GNATHION', self::CHIN_LEFT_GONION => 'CHIN_LEFT_GONION', self::CHIN_RIGHT_GONION => 'CHIN_RIGHT_GONION', self::LEFT_CHEEK_CENTER => 'LEFT_CHEEK_CENTER', self::RIGHT_CHEEK_CENTER => 'RIGHT_CHEEK_CENTER'] - - - - - - - - - - name - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::name() - - - value - - mixed - - - - - - - - - - - value - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::value() - - - name - - mixed - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Landmark - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark - - A face-specific landmark (for example, a face feature). - Generated from protobuf message <code>google.cloud.vision.v1.FaceAnnotation.Landmark</code> - - - - \Google\Protobuf\Internal\Message - - - - type - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::$type - 0 - - Face landmark type. - Generated from protobuf field <code>.google.cloud.vision.v1.FaceAnnotation.Landmark.Type type = 3;</code> - - - - - - position - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::$position - null - - Face landmark position. - Generated from protobuf field <code>.google.cloud.vision.v1.Position position = 4;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getType - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::getType() - - - Face landmark type. - Generated from protobuf field <code>.google.cloud.vision.v1.FaceAnnotation.Landmark.Type type = 3;</code> - - - - - - - setType - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::setType() - - - var - - int - - - - Face landmark type. - Generated from protobuf field <code>.google.cloud.vision.v1.FaceAnnotation.Landmark.Type type = 3;</code> - - - - - - - - getPosition - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::getPosition() - - - Face landmark position. - Generated from protobuf field <code>.google.cloud.vision.v1.Position position = 4;</code> - - - - - - - hasPosition - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::hasPosition() - - - - - - - - - - clearPosition - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::clearPosition() - - - - - - - - - - setPosition - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::setPosition() - - - var - - \Google\Cloud\Vision\V1\Position - - - - Face landmark position. - Generated from protobuf field <code>.google.cloud.vision.v1.Position position = 4;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - FaceAnnotation - \Google\Cloud\Vision\V1\FaceAnnotation - - A face annotation object contains the results of face detection. - Generated from protobuf message <code>google.cloud.vision.v1.FaceAnnotation</code> - - - - \Google\Protobuf\Internal\Message - - - - bounding_poly - \Google\Cloud\Vision\V1\FaceAnnotation::$bounding_poly - null - - The bounding polygon around the face. The coordinates of the bounding box -are in the original image's scale. - The bounding box is computed to "frame" the face in accordance with human -expectations. It is based on the landmarker results. -Note that one or more x and/or y coordinates may not be generated in the -`BoundingPoly` (the polygon will be unbounded) if only a partial face -appears in the image to be annotated. - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> - - - - - - fd_bounding_poly - \Google\Cloud\Vision\V1\FaceAnnotation::$fd_bounding_poly - null - - The `fd_bounding_poly` bounding polygon is tighter than the -`boundingPoly`, and encloses only the skin part of the face. Typically, it -is used to eliminate the face from any image analysis that detects the -"amount of skin" visible in an image. It is not based on the -landmarker results, only on the initial face detection, hence -the <code>fd</code> (face detection) prefix. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;</code> - - - - - - landmarks - \Google\Cloud\Vision\V1\FaceAnnotation::$landmarks - - - Detected face landmarks. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;</code> - - - - - - roll_angle - \Google\Cloud\Vision\V1\FaceAnnotation::$roll_angle - 0.0 - - Roll angle, which indicates the amount of clockwise/anti-clockwise rotation -of the face relative to the image vertical about the axis perpendicular to -the face. Range [-180,180]. - Generated from protobuf field <code>float roll_angle = 4;</code> - - - - - - pan_angle - \Google\Cloud\Vision\V1\FaceAnnotation::$pan_angle - 0.0 - - Yaw angle, which indicates the leftward/rightward angle that the face is -pointing relative to the vertical plane perpendicular to the image. Range -[-180,180]. - Generated from protobuf field <code>float pan_angle = 5;</code> - - - - - - tilt_angle - \Google\Cloud\Vision\V1\FaceAnnotation::$tilt_angle - 0.0 - - Pitch angle, which indicates the upwards/downwards angle that the face is -pointing relative to the image's horizontal plane. Range [-180,180]. - Generated from protobuf field <code>float tilt_angle = 6;</code> - - - - - - detection_confidence - \Google\Cloud\Vision\V1\FaceAnnotation::$detection_confidence - 0.0 - - Detection confidence. Range [0, 1]. - Generated from protobuf field <code>float detection_confidence = 7;</code> - - - - - - landmarking_confidence - \Google\Cloud\Vision\V1\FaceAnnotation::$landmarking_confidence - 0.0 - - Face landmarking confidence. Range [0, 1]. - Generated from protobuf field <code>float landmarking_confidence = 8;</code> - - - - - - joy_likelihood - \Google\Cloud\Vision\V1\FaceAnnotation::$joy_likelihood - 0 - - Joy likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood joy_likelihood = 9;</code> - - - - - - sorrow_likelihood - \Google\Cloud\Vision\V1\FaceAnnotation::$sorrow_likelihood - 0 - - Sorrow likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;</code> - - - - - - anger_likelihood - \Google\Cloud\Vision\V1\FaceAnnotation::$anger_likelihood - 0 - - Anger likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood anger_likelihood = 11;</code> - - - - - - surprise_likelihood - \Google\Cloud\Vision\V1\FaceAnnotation::$surprise_likelihood - 0 - - Surprise likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;</code> - - - - - - under_exposed_likelihood - \Google\Cloud\Vision\V1\FaceAnnotation::$under_exposed_likelihood - 0 - - Under-exposed likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;</code> - - - - - - blurred_likelihood - \Google\Cloud\Vision\V1\FaceAnnotation::$blurred_likelihood - 0 - - Blurred likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;</code> - - - - - - headwear_likelihood - \Google\Cloud\Vision\V1\FaceAnnotation::$headwear_likelihood - 0 - - Headwear likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\FaceAnnotation::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getBoundingPoly - \Google\Cloud\Vision\V1\FaceAnnotation::getBoundingPoly() - - - The bounding polygon around the face. The coordinates of the bounding box -are in the original image's scale. - The bounding box is computed to "frame" the face in accordance with human -expectations. It is based on the landmarker results. -Note that one or more x and/or y coordinates may not be generated in the -`BoundingPoly` (the polygon will be unbounded) if only a partial face -appears in the image to be annotated. - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> - - - - - - - hasBoundingPoly - \Google\Cloud\Vision\V1\FaceAnnotation::hasBoundingPoly() - - - - - - - - - - clearBoundingPoly - \Google\Cloud\Vision\V1\FaceAnnotation::clearBoundingPoly() - - - - - - - - - - setBoundingPoly - \Google\Cloud\Vision\V1\FaceAnnotation::setBoundingPoly() - - - var - - \Google\Cloud\Vision\V1\BoundingPoly - - - - The bounding polygon around the face. The coordinates of the bounding box -are in the original image's scale. - The bounding box is computed to "frame" the face in accordance with human -expectations. It is based on the landmarker results. -Note that one or more x and/or y coordinates may not be generated in the -`BoundingPoly` (the polygon will be unbounded) if only a partial face -appears in the image to be annotated. - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> - - - - - - - - getFdBoundingPoly - \Google\Cloud\Vision\V1\FaceAnnotation::getFdBoundingPoly() - - - The `fd_bounding_poly` bounding polygon is tighter than the -`boundingPoly`, and encloses only the skin part of the face. Typically, it -is used to eliminate the face from any image analysis that detects the -"amount of skin" visible in an image. It is not based on the -landmarker results, only on the initial face detection, hence -the <code>fd</code> (face detection) prefix. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;</code> - - - - - - - hasFdBoundingPoly - \Google\Cloud\Vision\V1\FaceAnnotation::hasFdBoundingPoly() - - - - - - - - - - clearFdBoundingPoly - \Google\Cloud\Vision\V1\FaceAnnotation::clearFdBoundingPoly() - - - - - - - - - - setFdBoundingPoly - \Google\Cloud\Vision\V1\FaceAnnotation::setFdBoundingPoly() - - - var - - \Google\Cloud\Vision\V1\BoundingPoly - - - - The `fd_bounding_poly` bounding polygon is tighter than the -`boundingPoly`, and encloses only the skin part of the face. Typically, it -is used to eliminate the face from any image analysis that detects the -"amount of skin" visible in an image. It is not based on the -landmarker results, only on the initial face detection, hence -the <code>fd</code> (face detection) prefix. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;</code> - - - - - - - - getLandmarks - \Google\Cloud\Vision\V1\FaceAnnotation::getLandmarks() - - - Detected face landmarks. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;</code> - - - - - - - setLandmarks - \Google\Cloud\Vision\V1\FaceAnnotation::setLandmarks() - - - var - - \Google\Cloud\Vision\V1\FaceAnnotation\Landmark[]|\Google\Protobuf\Internal\RepeatedField - - - - Detected face landmarks. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;</code> - - - - - - - - getRollAngle - \Google\Cloud\Vision\V1\FaceAnnotation::getRollAngle() - - - Roll angle, which indicates the amount of clockwise/anti-clockwise rotation -of the face relative to the image vertical about the axis perpendicular to -the face. Range [-180,180]. - Generated from protobuf field <code>float roll_angle = 4;</code> - - - - - - - setRollAngle - \Google\Cloud\Vision\V1\FaceAnnotation::setRollAngle() - - - var - - float - - - - Roll angle, which indicates the amount of clockwise/anti-clockwise rotation -of the face relative to the image vertical about the axis perpendicular to -the face. Range [-180,180]. - Generated from protobuf field <code>float roll_angle = 4;</code> - - - - - - - - getPanAngle - \Google\Cloud\Vision\V1\FaceAnnotation::getPanAngle() - - - Yaw angle, which indicates the leftward/rightward angle that the face is -pointing relative to the vertical plane perpendicular to the image. Range -[-180,180]. - Generated from protobuf field <code>float pan_angle = 5;</code> - - - - - - - setPanAngle - \Google\Cloud\Vision\V1\FaceAnnotation::setPanAngle() - - - var - - float - - - - Yaw angle, which indicates the leftward/rightward angle that the face is -pointing relative to the vertical plane perpendicular to the image. Range -[-180,180]. - Generated from protobuf field <code>float pan_angle = 5;</code> - - - - - - - - getTiltAngle - \Google\Cloud\Vision\V1\FaceAnnotation::getTiltAngle() - - - Pitch angle, which indicates the upwards/downwards angle that the face is -pointing relative to the image's horizontal plane. Range [-180,180]. - Generated from protobuf field <code>float tilt_angle = 6;</code> - - - - - - - setTiltAngle - \Google\Cloud\Vision\V1\FaceAnnotation::setTiltAngle() - - - var - - float - - - - Pitch angle, which indicates the upwards/downwards angle that the face is -pointing relative to the image's horizontal plane. Range [-180,180]. - Generated from protobuf field <code>float tilt_angle = 6;</code> - - - - - - - - getDetectionConfidence - \Google\Cloud\Vision\V1\FaceAnnotation::getDetectionConfidence() - - - Detection confidence. Range [0, 1]. - Generated from protobuf field <code>float detection_confidence = 7;</code> - - - - - - - setDetectionConfidence - \Google\Cloud\Vision\V1\FaceAnnotation::setDetectionConfidence() - - - var - - float - - - - Detection confidence. Range [0, 1]. - Generated from protobuf field <code>float detection_confidence = 7;</code> - - - - - - - - getLandmarkingConfidence - \Google\Cloud\Vision\V1\FaceAnnotation::getLandmarkingConfidence() - - - Face landmarking confidence. Range [0, 1]. - Generated from protobuf field <code>float landmarking_confidence = 8;</code> - - - - - - - setLandmarkingConfidence - \Google\Cloud\Vision\V1\FaceAnnotation::setLandmarkingConfidence() - - - var - - float - - - - Face landmarking confidence. Range [0, 1]. - Generated from protobuf field <code>float landmarking_confidence = 8;</code> - - - - - - - - getJoyLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::getJoyLikelihood() - - - Joy likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood joy_likelihood = 9;</code> - - - - - - - setJoyLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::setJoyLikelihood() - - - var - - int - - - - Joy likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood joy_likelihood = 9;</code> - - - - - - - - getSorrowLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::getSorrowLikelihood() - - - Sorrow likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;</code> - - - - - - - setSorrowLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::setSorrowLikelihood() - - - var - - int - - - - Sorrow likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;</code> - - - - - - - - getAngerLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::getAngerLikelihood() - - - Anger likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood anger_likelihood = 11;</code> - - - - - - - setAngerLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::setAngerLikelihood() - - - var - - int - - - - Anger likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood anger_likelihood = 11;</code> - - - - - - - - getSurpriseLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::getSurpriseLikelihood() - - - Surprise likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;</code> - - - - - - - setSurpriseLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::setSurpriseLikelihood() - - - var - - int - - - - Surprise likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;</code> - - - - - - - - getUnderExposedLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::getUnderExposedLikelihood() - - - Under-exposed likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;</code> - - - - - - - setUnderExposedLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::setUnderExposedLikelihood() - - - var - - int - - - - Under-exposed likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;</code> - - - - - - - - getBlurredLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::getBlurredLikelihood() - - - Blurred likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;</code> - - - - - - - setBlurredLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::setBlurredLikelihood() - - - var - - int - - - - Blurred likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;</code> - - - - - - - - getHeadwearLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::getHeadwearLikelihood() - - - Headwear likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;</code> - - - - - - - setHeadwearLikelihood - \Google\Cloud\Vision\V1\FaceAnnotation::setHeadwearLikelihood() - - - var - - int - - - - Headwear likelihood. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - FaceAnnotation_Landmark - \Google\Cloud\Vision\V1\FaceAnnotation_Landmark - - This class is deprecated. Use Google\Cloud\Vision\V1\FaceAnnotation\Landmark instead. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - FaceAnnotation_Landmark_Type - \Google\Cloud\Vision\V1\FaceAnnotation_Landmark_Type - - This class is deprecated. Use Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type instead. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Type - \Google\Cloud\Vision\V1\Feature\Type - - Type of Google Cloud Vision API feature to be extracted. - Protobuf type <code>google.cloud.vision.v1.Feature.Type</code> - - - - - - - TYPE_UNSPECIFIED - \Google\Cloud\Vision\V1\Feature\Type::TYPE_UNSPECIFIED - 0 - - Unspecified feature type. - Generated from protobuf enum <code>TYPE_UNSPECIFIED = 0;</code> - - - - - - FACE_DETECTION - \Google\Cloud\Vision\V1\Feature\Type::FACE_DETECTION - 1 - - Run face detection. - Generated from protobuf enum <code>FACE_DETECTION = 1;</code> - - - - - - LANDMARK_DETECTION - \Google\Cloud\Vision\V1\Feature\Type::LANDMARK_DETECTION - 2 - - Run landmark detection. - Generated from protobuf enum <code>LANDMARK_DETECTION = 2;</code> - - - - - - LOGO_DETECTION - \Google\Cloud\Vision\V1\Feature\Type::LOGO_DETECTION - 3 - - Run logo detection. - Generated from protobuf enum <code>LOGO_DETECTION = 3;</code> - - - - - - LABEL_DETECTION - \Google\Cloud\Vision\V1\Feature\Type::LABEL_DETECTION - 4 - - Run label detection. - Generated from protobuf enum <code>LABEL_DETECTION = 4;</code> - - - - - - TEXT_DETECTION - \Google\Cloud\Vision\V1\Feature\Type::TEXT_DETECTION - 5 - - Run text detection / optical character recognition (OCR). Text detection -is optimized for areas of text within a larger image; if the image is -a document, use `DOCUMENT_TEXT_DETECTION` instead. - Generated from protobuf enum <code>TEXT_DETECTION = 5;</code> - - - - - - DOCUMENT_TEXT_DETECTION - \Google\Cloud\Vision\V1\Feature\Type::DOCUMENT_TEXT_DETECTION - 11 - - Run dense text document OCR. Takes precedence when both -`DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present. - Generated from protobuf enum <code>DOCUMENT_TEXT_DETECTION = 11;</code> - - - - - - SAFE_SEARCH_DETECTION - \Google\Cloud\Vision\V1\Feature\Type::SAFE_SEARCH_DETECTION - 6 - - Run Safe Search to detect potentially unsafe -or undesirable content. - Generated from protobuf enum <code>SAFE_SEARCH_DETECTION = 6;</code> - - - - - - IMAGE_PROPERTIES - \Google\Cloud\Vision\V1\Feature\Type::IMAGE_PROPERTIES - 7 - - Compute a set of image properties, such as the -image's dominant colors. - Generated from protobuf enum <code>IMAGE_PROPERTIES = 7;</code> - - - - - - CROP_HINTS - \Google\Cloud\Vision\V1\Feature\Type::CROP_HINTS - 9 - - Run crop hints. - Generated from protobuf enum <code>CROP_HINTS = 9;</code> - - - - - - WEB_DETECTION - \Google\Cloud\Vision\V1\Feature\Type::WEB_DETECTION - 10 - - Run web detection. - Generated from protobuf enum <code>WEB_DETECTION = 10;</code> - - - - - - PRODUCT_SEARCH - \Google\Cloud\Vision\V1\Feature\Type::PRODUCT_SEARCH - 12 - - Run Product Search. - Generated from protobuf enum <code>PRODUCT_SEARCH = 12;</code> - - - - - - OBJECT_LOCALIZATION - \Google\Cloud\Vision\V1\Feature\Type::OBJECT_LOCALIZATION - 19 - - Run localizer for object detection. - Generated from protobuf enum <code>OBJECT_LOCALIZATION = 19;</code> - - - - - - - valueToName - \Google\Cloud\Vision\V1\Feature\Type::$valueToName - [self::TYPE_UNSPECIFIED => 'TYPE_UNSPECIFIED', self::FACE_DETECTION => 'FACE_DETECTION', self::LANDMARK_DETECTION => 'LANDMARK_DETECTION', self::LOGO_DETECTION => 'LOGO_DETECTION', self::LABEL_DETECTION => 'LABEL_DETECTION', self::TEXT_DETECTION => 'TEXT_DETECTION', self::DOCUMENT_TEXT_DETECTION => 'DOCUMENT_TEXT_DETECTION', self::SAFE_SEARCH_DETECTION => 'SAFE_SEARCH_DETECTION', self::IMAGE_PROPERTIES => 'IMAGE_PROPERTIES', self::CROP_HINTS => 'CROP_HINTS', self::WEB_DETECTION => 'WEB_DETECTION', self::PRODUCT_SEARCH => 'PRODUCT_SEARCH', self::OBJECT_LOCALIZATION => 'OBJECT_LOCALIZATION'] - - - - - - - - - - name - \Google\Cloud\Vision\V1\Feature\Type::name() - - - value - - mixed - - - - - - - - - - - value - \Google\Cloud\Vision\V1\Feature\Type::value() - - - name - - mixed - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Feature - \Google\Cloud\Vision\V1\Feature - - The type of Google Cloud Vision API detection to perform, and the maximum -number of results to return for that type. Multiple `Feature` objects can -be specified in the `features` list. - Generated from protobuf message <code>google.cloud.vision.v1.Feature</code> - - - - \Google\Protobuf\Internal\Message - - - - type - \Google\Cloud\Vision\V1\Feature::$type - 0 - - The feature type. - Generated from protobuf field <code>.google.cloud.vision.v1.Feature.Type type = 1;</code> - - - - - - max_results - \Google\Cloud\Vision\V1\Feature::$max_results - 0 - - Maximum number of results of this type. Does not apply to -`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. - Generated from protobuf field <code>int32 max_results = 2;</code> - - - - - - model - \Google\Cloud\Vision\V1\Feature::$model - '' - - Model to use for the feature. - Supported values: "builtin/stable" (the default if unset) and -"builtin/latest". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also -support "builtin/weekly" for the bleeding edge release updated weekly. - -Generated from protobuf field <code>string model = 3;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\Feature::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getType - \Google\Cloud\Vision\V1\Feature::getType() - - - The feature type. - Generated from protobuf field <code>.google.cloud.vision.v1.Feature.Type type = 1;</code> - - - - - - - setType - \Google\Cloud\Vision\V1\Feature::setType() - - - var - - int - - - - The feature type. - Generated from protobuf field <code>.google.cloud.vision.v1.Feature.Type type = 1;</code> - - - - - - - - getMaxResults - \Google\Cloud\Vision\V1\Feature::getMaxResults() - - - Maximum number of results of this type. Does not apply to -`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. - Generated from protobuf field <code>int32 max_results = 2;</code> - - - - - - - setMaxResults - \Google\Cloud\Vision\V1\Feature::setMaxResults() - - - var - - int - - - - Maximum number of results of this type. Does not apply to -`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. - Generated from protobuf field <code>int32 max_results = 2;</code> - - - - - - - - getModel - \Google\Cloud\Vision\V1\Feature::getModel() - - - Model to use for the feature. - Supported values: "builtin/stable" (the default if unset) and -"builtin/latest". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also -support "builtin/weekly" for the bleeding edge release updated weekly. - -Generated from protobuf field <code>string model = 3;</code> - - - - - - - setModel - \Google\Cloud\Vision\V1\Feature::setModel() - - - var - - string - - - - Model to use for the feature. - Supported values: "builtin/stable" (the default if unset) and -"builtin/latest". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also -support "builtin/weekly" for the bleeding edge release updated weekly. - -Generated from protobuf field <code>string model = 3;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Feature_Type - \Google\Cloud\Vision\V1\Feature_Type - - This class is deprecated. Use Google\Cloud\Vision\V1\Feature\Type instead. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ImageAnnotatorGapicClient - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - - Service Description: Service that performs Google Cloud Vision API detection tasks over client -images, such as face, landmark, logo, label, and text detection. The -ImageAnnotator service returns detected entities from the images. - 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: - -``` -$imageAnnotatorClient = new ImageAnnotatorClient(); -try { - $requests = []; - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - $result = $operationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $imageAnnotatorClient->resumeOperation($operationName, 'asyncBatchAnnotateFiles'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - $result = $newOperationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } -} finally { - $imageAnnotatorClient->close(); -} -``` - -Many parameters require resource names to be formatted in a particular way. To -assist with these names, this class includes a format method for each type of -name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. - - - - - - - - SERVICE_NAME - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_NAME - 'google.cloud.vision.v1.ImageAnnotator' - - The name of the service. - - - - - - - SERVICE_ADDRESS - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_ADDRESS - 'vision.googleapis.com' - - The default address of the service. - - - - - - - - SERVICE_ADDRESS_TEMPLATE - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_ADDRESS_TEMPLATE - 'vision.UNIVERSE_DOMAIN' - - The address template of the service. - - - - - - - DEFAULT_SERVICE_PORT - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::DEFAULT_SERVICE_PORT - 443 - - The default port of the service. - - - - - - - CODEGEN_NAME - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::CODEGEN_NAME - 'gapic' - - The name of the code generator, to be included in the agent header. - - - - - - - - serviceScopes - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$serviceScopes - ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - - The default scopes required by the service. - - - - - - - productSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$productSetNameTemplate - - - - - - - - - - pathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$pathTemplateMap - - - - - - - - - - operationsClient - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$operationsClient - - - - - - - - - - - getClientDefaults - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getClientDefaults() - - - - - - - - - - getProductSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getProductSetNameTemplate() - - - - - - - - - - getPathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getPathTemplateMap() - - - - - - - - - - productSetName - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::productSetName() - - - project - - string - - - - location - - string - - - - productSet - - string - - - - Formats a string containing the fully-qualified path to represent a product_set -resource. - - - - - - - - - - - parseName - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::parseName() - - - formattedName - - string - - - - template - null - string - - - - Parses a formatted name string and returns an associative array of the components in the name. - The following name formats are supported: -Template: Pattern -- productSet: projects/{project}/locations/{location}/productSets/{product_set} - -The optional $template argument can be supplied to specify a particular pattern, -and must match one of the templates listed above. If no $template argument is -provided, or if the $template argument does not match one of the templates -listed, then parseName will check each of the supported templates, and return -the first match. - - - - - - - - - - getOperationsClient - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getOperationsClient() - - - Return an OperationsClient object with the same endpoint as $this. - - - - - - - - resumeOperation - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::resumeOperation() - - - operationName - - string - - - - methodName - null - string - - - - Resume an existing long running operation that was previously started by a long -running API method. If $methodName is not provided, or does not match a long -running API method, then the operation can still be resumed, but the -OperationResponse object will not deserialize the final response. - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::__construct() - - - options - [] - array - - - - Constructor. - - - - - - - - - asyncBatchAnnotateFiles - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::asyncBatchAnnotateFiles() - - - requests - - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[] - - - - optionalArgs - [] - array - - - - Run asynchronous image detection and annotation for a list of generic -files, such as PDF files, which may contain multiple pages and multiple -images per page. Progress and results can be retrieved through the -`google.longrunning.Operations` interface. - `Operation.metadata` contains `OperationMetadata` (metadata). -`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). - -Sample code: -``` -$imageAnnotatorClient = new ImageAnnotatorClient(); -try { - $requests = []; - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - $result = $operationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $imageAnnotatorClient->resumeOperation($operationName, 'asyncBatchAnnotateFiles'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - $result = $newOperationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } -} finally { - $imageAnnotatorClient->close(); -} -``` - - - - - - - - - - asyncBatchAnnotateImages - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::asyncBatchAnnotateImages() - - - requests - - \Google\Cloud\Vision\V1\AnnotateImageRequest[] - - - - outputConfig - - \Google\Cloud\Vision\V1\OutputConfig - - - - optionalArgs - [] - array - - - - Run asynchronous image detection and annotation for a list of images. - Progress and results can be retrieved through the -`google.longrunning.Operations` interface. -`Operation.metadata` contains `OperationMetadata` (metadata). -`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - -This service will write image annotation outputs to json files in customer -GCS bucket, each json file containing BatchAnnotateImagesResponse proto. - -Sample code: -``` -$imageAnnotatorClient = new ImageAnnotatorClient(); -try { - $requests = []; - $outputConfig = new OutputConfig(); - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateImages($requests, $outputConfig); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - $result = $operationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateImages($requests, $outputConfig); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $imageAnnotatorClient->resumeOperation($operationName, 'asyncBatchAnnotateImages'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - $result = $newOperationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } -} finally { - $imageAnnotatorClient->close(); -} -``` - - - - - - - - - - - batchAnnotateFiles - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::batchAnnotateFiles() - - - requests - - \Google\Cloud\Vision\V1\AnnotateFileRequest[] - - - - optionalArgs - [] - array - - - - Service that performs image detection and annotation for a batch of files. - Now only "application/pdf", "image/tiff" and "image/gif" are supported. - -This service will extract at most 5 (customers can specify which 5 in -AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each -file provided and perform detection and annotation for each image -extracted. - -Sample code: -``` -$imageAnnotatorClient = new ImageAnnotatorClient(); -try { - $requests = []; - $response = $imageAnnotatorClient->batchAnnotateFiles($requests); -} finally { - $imageAnnotatorClient->close(); -} -``` - - - - - - - - - - batchAnnotateImages - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::batchAnnotateImages() - - - requests - - \Google\Cloud\Vision\V1\AnnotateImageRequest[] - - - - optionalArgs - [] - array - - - - Run image detection and annotation for a batch of images. - Sample code: -``` -$imageAnnotatorClient = new ImageAnnotatorClient(); -try { - $requests = []; - $response = $imageAnnotatorClient->batchAnnotateImages($requests); -} finally { - $imageAnnotatorClient->close(); -} -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ProductSearchGapicClient - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - Service Description: Manages Products and ProductSets of reference images for use in product -search. It uses the following resource model: - - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet] -resources, named `projects/&#42;/locations/&#42;/productSets/*`, which acts as a way -to put different products into groups to limit identification. - -In parallel, - -- The API has a collection of [Product][google.cloud.vision.v1.Product] -resources, named -`projects/&#42;/locations/&#42;/products/*` - -- Each [Product][google.cloud.vision.v1.Product] has a collection of -[ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named -`projects/&#42;/locations/&#42;/products/&#42;/referenceImages/*` - -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: - -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $formattedProduct = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $productSearchClient->addProductToProductSet($formattedName, $formattedProduct); -} finally { - $productSearchClient->close(); -} -``` - -Many parameters require resource names to be formatted in a particular way. To -assist with these names, this class includes a format method for each type of -name, and additionally a parseName method to extract the individual identifiers -contained within formatted names that are returned by the API. - - - - - - - - SERVICE_NAME - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_NAME - 'google.cloud.vision.v1.ProductSearch' - - The name of the service. - - - - - - - SERVICE_ADDRESS - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_ADDRESS - 'vision.googleapis.com' - - The default address of the service. - - - - - - - - SERVICE_ADDRESS_TEMPLATE - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_ADDRESS_TEMPLATE - 'vision.UNIVERSE_DOMAIN' - - The address template of the service. - - - - - - - DEFAULT_SERVICE_PORT - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::DEFAULT_SERVICE_PORT - 443 - - The default port of the service. - - - - - - - CODEGEN_NAME - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::CODEGEN_NAME - 'gapic' - - The name of the code generator, to be included in the agent header. - - - - - - - - serviceScopes - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$serviceScopes - ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - - The default scopes required by the service. - - - - - - - locationNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$locationNameTemplate - - - - - - - - - - productNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$productNameTemplate - - - - - - - - - - productSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$productSetNameTemplate - - - - - - - - - - referenceImageNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$referenceImageNameTemplate - - - - - - - - - - pathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$pathTemplateMap - - - - - - - - - - operationsClient - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$operationsClient - - - - - - - - - - - getClientDefaults - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getClientDefaults() - - - - - - - - - - getLocationNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getLocationNameTemplate() - - - - - - - - - - getProductNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductNameTemplate() - - - - - - - - - - getProductSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductSetNameTemplate() - - - - - - - - - - getReferenceImageNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getReferenceImageNameTemplate() - - - - - - - - - - getPathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getPathTemplateMap() - - - - - - - - - - locationName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::locationName() - - - project - - string - - - - location - - string - - - - Formats a string containing the fully-qualified path to represent a location -resource. - - - - - - - - - - productName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::productName() - - - project - - string - - - - location - - string - - - - product - - string - - - - Formats a string containing the fully-qualified path to represent a product -resource. - - - - - - - - - - - productSetName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::productSetName() - - - project - - string - - - - location - - string - - - - productSet - - string - - - - Formats a string containing the fully-qualified path to represent a product_set -resource. - - - - - - - - - - - referenceImageName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::referenceImageName() - - - project - - string - - - - location - - string - - - - product - - string - - - - referenceImage - - string - - - - Formats a string containing the fully-qualified path to represent a -reference_image resource. - - - - - - - - - - - - parseName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::parseName() - - - formattedName - - string - - - - template - null - string - - - - Parses a formatted name string and returns an associative array of the components in the name. - The following name formats are supported: -Template: Pattern -- location: projects/{project}/locations/{location} -- product: projects/{project}/locations/{location}/products/{product} -- productSet: projects/{project}/locations/{location}/productSets/{product_set} -- referenceImage: projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image} - -The optional $template argument can be supplied to specify a particular pattern, -and must match one of the templates listed above. If no $template argument is -provided, or if the $template argument does not match one of the templates -listed, then parseName will check each of the supported templates, and return -the first match. - - - - - - - - - - getOperationsClient - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getOperationsClient() - - - Return an OperationsClient object with the same endpoint as $this. - - - - - - - - resumeOperation - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::resumeOperation() - - - operationName - - string - - - - methodName - null - string - - - - Resume an existing long running operation that was previously started by a long -running API method. If $methodName is not provided, or does not match a long -running API method, then the operation can still be resumed, but the -OperationResponse object will not deserialize the final response. - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::__construct() - - - options - [] - array - - - - Constructor. - - - - - - - - - addProductToProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::addProductToProductSet() - - - name - - string - - - - product - - string - - - - optionalArgs - [] - array - - - - Adds a Product to the specified ProductSet. If the Product is already -present, no change is made. - One Product can be added to at most 100 ProductSets. - -Possible errors: - -* Returns NOT_FOUND if the Product or the ProductSet doesn't exist. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $formattedProduct = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $productSearchClient->addProductToProductSet($formattedName, $formattedProduct); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - createProduct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createProduct() - - - parent - - string - - - - product - - \Google\Cloud\Vision\V1\Product - - - - optionalArgs - [] - array - - - - Creates and returns a new product resource. - Possible errors: - -* Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 -characters. -* Returns INVALID_ARGUMENT if description is longer than 4096 characters. -* Returns INVALID_ARGUMENT if product_category is missing or invalid. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - $product = new Product(); - $response = $productSearchClient->createProduct($formattedParent, $product); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - - createProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createProductSet() - - - parent - - string - - - - productSet - - \Google\Cloud\Vision\V1\ProductSet - - - - optionalArgs - [] - array - - - - Creates and returns a new ProductSet resource. - Possible errors: - -* Returns INVALID_ARGUMENT if display_name is missing, or is longer than -4096 characters. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - $productSet = new ProductSet(); - $response = $productSearchClient->createProductSet($formattedParent, $productSet); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - - createReferenceImage - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createReferenceImage() - - - parent - - string - - - - referenceImage - - \Google\Cloud\Vision\V1\ReferenceImage - - - - optionalArgs - [] - array - - - - Creates and returns a new ReferenceImage resource. - The `bounding_poly` field is optional. If `bounding_poly` is not specified, -the system will try to detect regions of interest in the image that are -compatible with the product_category on the parent product. If it is -specified, detection is ALWAYS skipped. The system converts polygons into -non-rotated rectangles. - -Note that the pipeline will resize the image if the image resolution is too -large to process (above 50MP). - -Possible errors: - -* Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 -characters. -* Returns INVALID_ARGUMENT if the product does not exist. -* Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing -compatible with the parent product's product_category is detected. -* Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $referenceImage = new ReferenceImage(); - $response = $productSearchClient->createReferenceImage($formattedParent, $referenceImage); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - - deleteProduct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteProduct() - - - name - - string - - - - optionalArgs - [] - array - - - - Permanently deletes a product and its reference images. - Metadata of the product and all its images will be deleted right away, but -search queries against ProductSets containing the product may still work -until all related caches are refreshed. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $productSearchClient->deleteProduct($formattedName); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - deleteProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteProductSet() - - - name - - string - - - - optionalArgs - [] - array - - - - Permanently deletes a ProductSet. Products and ReferenceImages in the -ProductSet are not deleted. - The actual image files are not deleted from Google Cloud Storage. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $productSearchClient->deleteProductSet($formattedName); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - deleteReferenceImage - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteReferenceImage() - - - name - - string - - - - optionalArgs - [] - array - - - - Permanently deletes a reference image. - The image metadata will be deleted right away, but search queries -against ProductSets containing the image may still work until all related -caches are refreshed. - -The actual image files are not deleted from Google Cloud Storage. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->referenceImageName('[PROJECT]', '[LOCATION]', '[PRODUCT]', '[REFERENCE_IMAGE]'); - $productSearchClient->deleteReferenceImage($formattedName); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - getProduct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProduct() - - - name - - string - - - - optionalArgs - [] - array - - - - Gets information associated with a Product. - Possible errors: - -* Returns NOT_FOUND if the Product does not exist. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $response = $productSearchClient->getProduct($formattedName); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - getProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductSet() - - - name - - string - - - - optionalArgs - [] - array - - - - Gets information associated with a ProductSet. - Possible errors: - -* Returns NOT_FOUND if the ProductSet does not exist. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $response = $productSearchClient->getProductSet($formattedName); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - getReferenceImage - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getReferenceImage() - - - name - - string - - - - optionalArgs - [] - array - - - - Gets information associated with a ReferenceImage. - Possible errors: - -* Returns NOT_FOUND if the specified image does not exist. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->referenceImageName('[PROJECT]', '[LOCATION]', '[PRODUCT]', '[REFERENCE_IMAGE]'); - $response = $productSearchClient->getReferenceImage($formattedName); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - importProductSets - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::importProductSets() - - - parent - - string - - - - inputConfig - - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig - - - - optionalArgs - [] - array - - - - Asynchronous API that imports a list of reference images to specified -product sets based on a list of image information. - The [google.longrunning.Operation][google.longrunning.Operation] API can be -used to keep track of the progress and results of the request. -`Operation.metadata` contains `BatchOperationMetadata`. (progress) -`Operation.response` contains `ImportProductSetsResponse`. (results) - -The input source of this method is a csv file on Google Cloud Storage. -For the format of the csv file please see -[ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri]. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - $inputConfig = new ImportProductSetsInputConfig(); - $operationResponse = $productSearchClient->importProductSets($formattedParent, $inputConfig); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - $result = $operationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $productSearchClient->importProductSets($formattedParent, $inputConfig); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $productSearchClient->resumeOperation($operationName, 'importProductSets'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - $result = $newOperationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - - listProductSets - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProductSets() - - - parent - - string - - - - optionalArgs - [] - array - - - - Lists ProductSets in an unspecified order. - Possible errors: - -* Returns INVALID_ARGUMENT if page_size is greater than 100, or less -than 1. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - // Iterate over pages of elements - $pagedResponse = $productSearchClient->listProductSets($formattedParent); - foreach ($pagedResponse->iteratePages() as $page) { - foreach ($page as $element) { - // doSomethingWith($element); - } - } - // Alternatively: - // Iterate through all elements - $pagedResponse = $productSearchClient->listProductSets($formattedParent); - foreach ($pagedResponse->iterateAllElements() as $element) { - // doSomethingWith($element); - } -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - listProducts - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProducts() - - - parent - - string - - - - optionalArgs - [] - array - - - - Lists products in an unspecified order. - Possible errors: - -* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - // Iterate over pages of elements - $pagedResponse = $productSearchClient->listProducts($formattedParent); - foreach ($pagedResponse->iteratePages() as $page) { - foreach ($page as $element) { - // doSomethingWith($element); - } - } - // Alternatively: - // Iterate through all elements - $pagedResponse = $productSearchClient->listProducts($formattedParent); - foreach ($pagedResponse->iterateAllElements() as $element) { - // doSomethingWith($element); - } -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - listProductsInProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProductsInProductSet() - - - name - - string - - - - optionalArgs - [] - array - - - - Lists the Products in a ProductSet, in an unspecified order. If the -ProductSet does not exist, the products field of the response will be -empty. - Possible errors: - -* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - // Iterate over pages of elements - $pagedResponse = $productSearchClient->listProductsInProductSet($formattedName); - foreach ($pagedResponse->iteratePages() as $page) { - foreach ($page as $element) { - // doSomethingWith($element); - } - } - // Alternatively: - // Iterate through all elements - $pagedResponse = $productSearchClient->listProductsInProductSet($formattedName); - foreach ($pagedResponse->iterateAllElements() as $element) { - // doSomethingWith($element); - } -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - listReferenceImages - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listReferenceImages() - - - parent - - string - - - - optionalArgs - [] - array - - - - Lists reference images. - Possible errors: - -* Returns NOT_FOUND if the parent product does not exist. -* Returns INVALID_ARGUMENT if the page_size is greater than 100, or less -than 1. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - // Iterate over pages of elements - $pagedResponse = $productSearchClient->listReferenceImages($formattedParent); - foreach ($pagedResponse->iteratePages() as $page) { - foreach ($page as $element) { - // doSomethingWith($element); - } - } - // Alternatively: - // Iterate through all elements - $pagedResponse = $productSearchClient->listReferenceImages($formattedParent); - foreach ($pagedResponse->iterateAllElements() as $element) { - // doSomethingWith($element); - } -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - purgeProducts - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::purgeProducts() - - - parent - - string - - - - optionalArgs - [] - array - - - - Asynchronous API to delete all Products in a ProductSet or all Products -that are in no ProductSet. - If a Product is a member of the specified ProductSet in addition to other -ProductSets, the Product will still be deleted. - -It is recommended to not delete the specified ProductSet until after this -operation has completed. It is also recommended to not add any of the -Products involved in the batch delete to a new ProductSet while this -operation is running because those Products may still end up deleted. - -It's not possible to undo the PurgeProducts operation. Therefore, it is -recommended to keep the csv files used in ImportProductSets (if that was -how you originally built the Product Set) before starting PurgeProducts, in -case you need to re-import the data after deletion. - -If the plan is to purge all of the Products from a ProductSet and then -re-use the empty ProductSet to re-import new Products into the empty -ProductSet, you must wait until the PurgeProducts operation has finished -for that ProductSet. - -The [google.longrunning.Operation][google.longrunning.Operation] API can be -used to keep track of the progress and results of the request. -`Operation.metadata` contains `BatchOperationMetadata`. (progress) - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - $operationResponse = $productSearchClient->purgeProducts($formattedParent); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - // operation succeeded and returns no value - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $productSearchClient->purgeProducts($formattedParent); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $productSearchClient->resumeOperation($operationName, 'purgeProducts'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - // operation succeeded and returns no value - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - removeProductFromProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::removeProductFromProductSet() - - - name - - string - - - - product - - string - - - - optionalArgs - [] - array - - - - Removes a Product from the specified ProductSet. - Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $formattedProduct = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $productSearchClient->removeProductFromProductSet($formattedName, $formattedProduct); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - updateProduct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::updateProduct() - - - product - - \Google\Cloud\Vision\V1\Product - - - - optionalArgs - [] - array - - - - Makes changes to a Product resource. - Only the `display_name`, `description`, and `labels` fields can be updated -right now. - -If labels are updated, the change will not be reflected in queries until -the next index time. - -Possible errors: - -* Returns NOT_FOUND if the Product does not exist. -* Returns INVALID_ARGUMENT if display_name is present in update_mask but is -missing from the request or longer than 4096 characters. -* Returns INVALID_ARGUMENT if description is present in update_mask but is -longer than 4096 characters. -* Returns INVALID_ARGUMENT if product_category is present in update_mask. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $product = new Product(); - $response = $productSearchClient->updateProduct($product); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - updateProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::updateProductSet() - - - productSet - - \Google\Cloud\Vision\V1\ProductSet - - - - optionalArgs - [] - array - - - - Makes changes to a ProductSet resource. - Only display_name can be updated currently. - -Possible errors: - -* Returns NOT_FOUND if the ProductSet does not exist. -* Returns INVALID_ARGUMENT if display_name is present in update_mask but -missing from the request or longer than 4096 characters. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $productSet = new ProductSet(); - $response = $productSearchClient->updateProductSet($productSet); -} finally { - $productSearchClient->close(); -} -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - GcsDestination - \Google\Cloud\Vision\V1\GcsDestination - - The Google Cloud Storage location where the output will be written to. - Generated from protobuf message <code>google.cloud.vision.v1.GcsDestination</code> - - - - \Google\Protobuf\Internal\Message - - - - uri - \Google\Cloud\Vision\V1\GcsDestination::$uri - '' - - Google Cloud Storage URI prefix where the results will be stored. Results -will be in JSON format and preceded by its corresponding input URI prefix. - This field can either represent a gcs file prefix or gcs directory. In -either case, the uri should be unique because in order to get all of the -output files, you will need to do a wildcard gcs search on the uri prefix -you provide. -Examples: -* File Prefix: gs://bucket-name/here/filenameprefix The output files -will be created in gs://bucket-name/here/ and the names of the -output files will begin with "filenameprefix". -* Directory Prefix: gs://bucket-name/some/location/ The output files -will be created in gs://bucket-name/some/location/ and the names of the -output files could be anything because there was no filename prefix -specified. -If multiple outputs, each response is still AnnotateFileResponse, each of -which contains some subset of the full list of AnnotateImageResponse. -Multiple outputs can happen if, for example, the output JSON is too large -and overflows into multiple sharded files. - -Generated from protobuf field <code>string uri = 1;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\GcsDestination::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getUri - \Google\Cloud\Vision\V1\GcsDestination::getUri() - - - Google Cloud Storage URI prefix where the results will be stored. Results -will be in JSON format and preceded by its corresponding input URI prefix. - This field can either represent a gcs file prefix or gcs directory. In -either case, the uri should be unique because in order to get all of the -output files, you will need to do a wildcard gcs search on the uri prefix -you provide. -Examples: -* File Prefix: gs://bucket-name/here/filenameprefix The output files -will be created in gs://bucket-name/here/ and the names of the -output files will begin with "filenameprefix". -* Directory Prefix: gs://bucket-name/some/location/ The output files -will be created in gs://bucket-name/some/location/ and the names of the -output files could be anything because there was no filename prefix -specified. -If multiple outputs, each response is still AnnotateFileResponse, each of -which contains some subset of the full list of AnnotateImageResponse. -Multiple outputs can happen if, for example, the output JSON is too large -and overflows into multiple sharded files. - -Generated from protobuf field <code>string uri = 1;</code> - - - - - - - setUri - \Google\Cloud\Vision\V1\GcsDestination::setUri() - - - var - - string - - - - Google Cloud Storage URI prefix where the results will be stored. Results -will be in JSON format and preceded by its corresponding input URI prefix. - This field can either represent a gcs file prefix or gcs directory. In -either case, the uri should be unique because in order to get all of the -output files, you will need to do a wildcard gcs search on the uri prefix -you provide. -Examples: -* File Prefix: gs://bucket-name/here/filenameprefix The output files -will be created in gs://bucket-name/here/ and the names of the -output files will begin with "filenameprefix". -* Directory Prefix: gs://bucket-name/some/location/ The output files -will be created in gs://bucket-name/some/location/ and the names of the -output files could be anything because there was no filename prefix -specified. -If multiple outputs, each response is still AnnotateFileResponse, each of -which contains some subset of the full list of AnnotateImageResponse. -Multiple outputs can happen if, for example, the output JSON is too large -and overflows into multiple sharded files. - -Generated from protobuf field <code>string uri = 1;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - GcsSource - \Google\Cloud\Vision\V1\GcsSource - - The Google Cloud Storage location where the input will be read from. - Generated from protobuf message <code>google.cloud.vision.v1.GcsSource</code> - - - - \Google\Protobuf\Internal\Message - - - - uri - \Google\Cloud\Vision\V1\GcsSource::$uri - '' - - Google Cloud Storage URI for the input file. This must only be a -Google Cloud Storage object. Wildcards are not currently supported. - Generated from protobuf field <code>string uri = 1;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\GcsSource::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getUri - \Google\Cloud\Vision\V1\GcsSource::getUri() - - - Google Cloud Storage URI for the input file. This must only be a -Google Cloud Storage object. Wildcards are not currently supported. - Generated from protobuf field <code>string uri = 1;</code> - - - - - - - setUri - \Google\Cloud\Vision\V1\GcsSource::setUri() - - - var - - string - - - - Google Cloud Storage URI for the input file. This must only be a -Google Cloud Storage object. Wildcards are not currently supported. - Generated from protobuf field <code>string uri = 1;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - GetProductRequest - \Google\Cloud\Vision\V1\GetProductRequest - - Request message for the `GetProduct` method. - Generated from protobuf message <code>google.cloud.vision.v1.GetProductRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - name - \Google\Cloud\Vision\V1\GetProductRequest::$name - '' - - Required. Resource name of the Product to get. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - build - \Google\Cloud\Vision\V1\GetProductRequest::build() - - - name - - string - - - - - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\GetProductRequest::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getName - \Google\Cloud\Vision\V1\GetProductRequest::getName() - - - Required. Resource name of the Product to get. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - setName - \Google\Cloud\Vision\V1\GetProductRequest::setName() - - - var - - string - - - - Required. Resource name of the Product to get. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - GetProductSetRequest - \Google\Cloud\Vision\V1\GetProductSetRequest - - Request message for the `GetProductSet` method. - Generated from protobuf message <code>google.cloud.vision.v1.GetProductSetRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - name - \Google\Cloud\Vision\V1\GetProductSetRequest::$name - '' - - Required. Resource name of the ProductSet to get. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - build - \Google\Cloud\Vision\V1\GetProductSetRequest::build() - - - name - - string - - - - - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\GetProductSetRequest::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getName - \Google\Cloud\Vision\V1\GetProductSetRequest::getName() - - - Required. Resource name of the ProductSet to get. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - setName - \Google\Cloud\Vision\V1\GetProductSetRequest::setName() - - - var - - string - - - - Required. Resource name of the ProductSet to get. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - GetReferenceImageRequest - \Google\Cloud\Vision\V1\GetReferenceImageRequest - - Request message for the `GetReferenceImage` method. - Generated from protobuf message <code>google.cloud.vision.v1.GetReferenceImageRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - name - \Google\Cloud\Vision\V1\GetReferenceImageRequest::$name - '' - - Required. The resource name of the ReferenceImage to get. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - build - \Google\Cloud\Vision\V1\GetReferenceImageRequest::build() - - - name - - string - - - - - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\GetReferenceImageRequest::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getName - \Google\Cloud\Vision\V1\GetReferenceImageRequest::getName() - - - Required. The resource name of the ReferenceImage to get. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - setName - \Google\Cloud\Vision\V1\GetReferenceImageRequest::setName() - - - var - - string - - - - Required. The resource name of the ReferenceImage to get. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Image - \Google\Cloud\Vision\V1\Image - - Client image to perform Google Cloud Vision API tasks over. - Generated from protobuf message <code>google.cloud.vision.v1.Image</code> - - - - \Google\Protobuf\Internal\Message - - - - content - \Google\Cloud\Vision\V1\Image::$content - '' - - Image content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary -representation, whereas JSON representations use base64. -Currently, this field only works for BatchAnnotateImages requests. It does -not work for AsyncBatchAnnotateImages requests. - -Generated from protobuf field <code>bytes content = 1;</code> - - - - - - source - \Google\Cloud\Vision\V1\Image::$source - null - - Google Cloud Storage image location, or publicly-accessible image -URL. If both `content` and `source` are provided for an image, `content` -takes precedence and is used to perform the image annotation request. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageSource source = 2;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\Image::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getContent - \Google\Cloud\Vision\V1\Image::getContent() - - - Image content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary -representation, whereas JSON representations use base64. -Currently, this field only works for BatchAnnotateImages requests. It does -not work for AsyncBatchAnnotateImages requests. - -Generated from protobuf field <code>bytes content = 1;</code> - - - - - - - setContent - \Google\Cloud\Vision\V1\Image::setContent() - - - var - - string - - - - Image content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary -representation, whereas JSON representations use base64. -Currently, this field only works for BatchAnnotateImages requests. It does -not work for AsyncBatchAnnotateImages requests. - -Generated from protobuf field <code>bytes content = 1;</code> - - - - - - - - getSource - \Google\Cloud\Vision\V1\Image::getSource() - - - Google Cloud Storage image location, or publicly-accessible image -URL. If both `content` and `source` are provided for an image, `content` -takes precedence and is used to perform the image annotation request. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageSource source = 2;</code> - - - - - - - hasSource - \Google\Cloud\Vision\V1\Image::hasSource() - - - - - - - - - - clearSource - \Google\Cloud\Vision\V1\Image::clearSource() - - - - - - - - - - setSource - \Google\Cloud\Vision\V1\Image::setSource() - - - var - - \Google\Cloud\Vision\V1\ImageSource - - - - Google Cloud Storage image location, or publicly-accessible image -URL. If both `content` and `source` are provided for an image, `content` -takes precedence and is used to perform the image annotation request. - Generated from protobuf field <code>.google.cloud.vision.v1.ImageSource source = 2;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ImageAnnotationContext - \Google\Cloud\Vision\V1\ImageAnnotationContext - - If an image was produced from a file (e.g. a PDF), this message gives -information about the source of that image. - Generated from protobuf message <code>google.cloud.vision.v1.ImageAnnotationContext</code> - - - - \Google\Protobuf\Internal\Message - - - - uri - \Google\Cloud\Vision\V1\ImageAnnotationContext::$uri - '' - - The URI of the file used to produce the image. - Generated from protobuf field <code>string uri = 1;</code> - - - - - - page_number - \Google\Cloud\Vision\V1\ImageAnnotationContext::$page_number - 0 - - If the file was a PDF or TIFF, this field gives the page number within -the file used to produce the image. - Generated from protobuf field <code>int32 page_number = 2;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\ImageAnnotationContext::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getUri - \Google\Cloud\Vision\V1\ImageAnnotationContext::getUri() - - - The URI of the file used to produce the image. - Generated from protobuf field <code>string uri = 1;</code> - - - - - - - setUri - \Google\Cloud\Vision\V1\ImageAnnotationContext::setUri() - - - var - - string - - - - The URI of the file used to produce the image. - Generated from protobuf field <code>string uri = 1;</code> - - - - - - - - getPageNumber - \Google\Cloud\Vision\V1\ImageAnnotationContext::getPageNumber() - - - If the file was a PDF or TIFF, this field gives the page number within -the file used to produce the image. - Generated from protobuf field <code>int32 page_number = 2;</code> - - - - - - - setPageNumber - \Google\Cloud\Vision\V1\ImageAnnotationContext::setPageNumber() - - - var - - int - - - - If the file was a PDF or TIFF, this field gives the page number within -the file used to produce the image. - Generated from protobuf field <code>int32 page_number = 2;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ImageAnnotatorClient - \Google\Cloud\Vision\V1\ImageAnnotatorClient - - Service Description: Service that performs Google Cloud Vision API detection tasks over client -images, such as face, landmark, logo, label, and text detection. The -ImageAnnotator service returns detected entities from the images. - - - - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - - - SERVICE_NAME - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_NAME - 'google.cloud.vision.v1.ImageAnnotator' - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - The name of the service. - - - - - - - SERVICE_ADDRESS - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_ADDRESS - 'vision.googleapis.com' - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - The default address of the service. - - - - - - - - SERVICE_ADDRESS_TEMPLATE - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::SERVICE_ADDRESS_TEMPLATE - 'vision.UNIVERSE_DOMAIN' - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - The address template of the service. - - - - - - - DEFAULT_SERVICE_PORT - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::DEFAULT_SERVICE_PORT - 443 - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - The default port of the service. - - - - - - - CODEGEN_NAME - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::CODEGEN_NAME - 'gapic' - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - The name of the code generator, to be included in the agent header. - - - - - - - - serviceScopes - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$serviceScopes - ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - The default scopes required by the service. - - - - - - - productSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$productSetNameTemplate - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - - - - - - - - pathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$pathTemplateMap - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - - - - - - - - operationsClient - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::$operationsClient - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - - - - - - - - urlSchemes - \Google\Cloud\Vision\VisionHelpersTrait::$urlSchemes - ['http', 'https', 'gs'] - \Google\Cloud\Vision\VisionHelpersTrait - A list of allowed url schemes. - - - - - - - - - createImageObject - \Google\Cloud\Vision\V1\ImageAnnotatorClient::createImageObject() - - - imageInput - - resource|string - - - - Creates an Image object that can be used as part of an image annotation request. - Example: -``` -//[snippet=resource] -$imageResource = fopen('path/to/image.jpg', 'r'); -$image = $imageAnnotatorClient->createImageObject($imageResource); -$response = $imageAnnotatorClient->faceDetection($image); -``` - -``` -//[snippet=data] -$imageData = file_get_contents('path/to/image.jpg'); -$image = $imageAnnotatorClient->createImageObject($imageData); -$response = $imageAnnotatorClient->faceDetection($image); -``` - -``` -//[snippet=url] -$imageUri = "gs://my-bucket/image.jpg"; -$image = $imageAnnotatorClient->createImageObject($imageUri); -$response = $imageAnnotatorClient->faceDetection($image); -``` - - - - - - - - - annotateImage - \Google\Cloud\Vision\V1\ImageAnnotatorClient::annotateImage() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - features - - \Google\Cloud\Vision\V1\Feature[]|int[] - - - - optionalArgs - [] - array - - - - Run image detection and annotation for an image. - Example: -``` -use Google\Cloud\Vision\V1\Feature; -use Google\Cloud\Vision\V1\Feature\Type; - -$imageResource = fopen('path/to/image.jpg', 'r'); -$features = [Type::FACE_DETECTION]; -$response = $imageAnnotatorClient->annotateImage($imageResource, $features); -``` - - - - - - - - - - - faceDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::faceDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run face detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->faceDetection($imageContent); -``` - - - - - - - - - - landmarkDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::landmarkDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run landmark detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->landmarkDetection($imageContent); -``` - - - - - - - - - - logoDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::logoDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run logo detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->logoDetection($imageContent); -``` - - - - - - - - - - labelDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::labelDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run label detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->labelDetection($imageContent); -``` - - - - - - - - - - textDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::textDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run text detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->textDetection($imageContent); -``` - - - - - - - - - - documentTextDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::documentTextDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run document text detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->documentTextDetection($imageContent); -``` - - - - - - - - - - safeSearchDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::safeSearchDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run safe search detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->safeSearchDetection($imageContent); -``` - - - - - - - - - - imagePropertiesDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::imagePropertiesDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run image properties detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->imagePropertiesDetection($imageContent); -``` - - - - - - - - - - cropHintsDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::cropHintsDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run crop hints detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->cropHintsDetection($imageContent); -``` - - - - - - - - - - webDetection - \Google\Cloud\Vision\V1\ImageAnnotatorClient::webDetection() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run web detection for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->webDetection($imageContent); -``` - - - - - - - - - - objectLocalization - \Google\Cloud\Vision\V1\ImageAnnotatorClient::objectLocalization() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - optionalArgs - [] - array - - - - Run object localization for an image. - Example: -``` -$imageContent = file_get_contents('path/to/image.jpg'); -$response = $imageAnnotatorClient->objectLocalization($imageContent); -``` - - - - - - - - - - productSearch - \Google\Cloud\Vision\V1\ImageAnnotatorClient::productSearch() - - - image - - resource|string|\Google\Cloud\Vision\V1\Image - - - - productSearchParams - - \Google\Cloud\Vision\V1\ProductSearchParams - - - - optionalArgs - [] - array - - - - Run product search for an image. - Example: -``` -use Google\Cloud\Vision\V1\ProductSearchClient; -use Google\Cloud\Vision\V1\ProductSearchParams; - -$imageContent = file_get_contents('path/to/image.jpg'); -$productSetName = ProductSearchClient::productSetName('PROJECT_ID', 'LOC_ID', 'PRODUCT_SET_ID'); -$productSearchParams = (new ProductSearchParams) - ->setProductSet($productSetName); -$response = $imageAnnotatorClient->productSearch( - $imageContent, - $productSearchParams -); -``` - - - - - - - - - - - annotateSingleFeature - \Google\Cloud\Vision\V1\ImageAnnotatorClient::annotateSingleFeature() - - - image - - \Google\Cloud\Vision\V1\Image - - - - featureType - - \Google\Cloud\Vision\V1\Feature|int - - - - optionalArgs - - array - - - - - - - - - - - - - - - getClientDefaults - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getClientDefaults() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - - - - - - - - getProductSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getProductSetNameTemplate() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - - - - - - - - getPathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getPathTemplateMap() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - - - - - - - - productSetName - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::productSetName() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - project - - string - - - - location - - string - - - - productSet - - string - - - - Formats a string containing the fully-qualified path to represent a product_set -resource. - - - - - - - - - - - parseName - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::parseName() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - formattedName - - string - - - - template - null - string - - - - Parses a formatted name string and returns an associative array of the components in the name. - The following name formats are supported: -Template: Pattern -- productSet: projects/{project}/locations/{location}/productSets/{product_set} - -The optional $template argument can be supplied to specify a particular pattern, -and must match one of the templates listed above. If no $template argument is -provided, or if the $template argument does not match one of the templates -listed, then parseName will check each of the supported templates, and return -the first match. - - - - - - - - - - getOperationsClient - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::getOperationsClient() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - Return an OperationsClient object with the same endpoint as $this. - - - - - - - - resumeOperation - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::resumeOperation() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - operationName - - string - - - - methodName - null - string - - - - Resume an existing long running operation that was previously started by a long -running API method. If $methodName is not provided, or does not match a long -running API method, then the operation can still be resumed, but the -OperationResponse object will not deserialize the final response. - - - - - - - - - - __construct - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::__construct() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - options - [] - array - - - - Constructor. - - - - - - - - - asyncBatchAnnotateFiles - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::asyncBatchAnnotateFiles() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - requests - - \Google\Cloud\Vision\V1\AsyncAnnotateFileRequest[] - - - - optionalArgs - [] - array - - - - Run asynchronous image detection and annotation for a list of generic -files, such as PDF files, which may contain multiple pages and multiple -images per page. Progress and results can be retrieved through the -`google.longrunning.Operations` interface. - `Operation.metadata` contains `OperationMetadata` (metadata). -`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). - -Sample code: -``` -$imageAnnotatorClient = new ImageAnnotatorClient(); -try { - $requests = []; - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - $result = $operationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateFiles($requests); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $imageAnnotatorClient->resumeOperation($operationName, 'asyncBatchAnnotateFiles'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - $result = $newOperationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } -} finally { - $imageAnnotatorClient->close(); -} -``` - - - - - - - - - - asyncBatchAnnotateImages - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::asyncBatchAnnotateImages() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - requests - - \Google\Cloud\Vision\V1\AnnotateImageRequest[] - - - - outputConfig - - \Google\Cloud\Vision\V1\OutputConfig - - - - optionalArgs - [] - array - - - - Run asynchronous image detection and annotation for a list of images. - Progress and results can be retrieved through the -`google.longrunning.Operations` interface. -`Operation.metadata` contains `OperationMetadata` (metadata). -`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - -This service will write image annotation outputs to json files in customer -GCS bucket, each json file containing BatchAnnotateImagesResponse proto. - -Sample code: -``` -$imageAnnotatorClient = new ImageAnnotatorClient(); -try { - $requests = []; - $outputConfig = new OutputConfig(); - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateImages($requests, $outputConfig); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - $result = $operationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $imageAnnotatorClient->asyncBatchAnnotateImages($requests, $outputConfig); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $imageAnnotatorClient->resumeOperation($operationName, 'asyncBatchAnnotateImages'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - $result = $newOperationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } -} finally { - $imageAnnotatorClient->close(); -} -``` - - - - - - - - - - - batchAnnotateFiles - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::batchAnnotateFiles() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - requests - - \Google\Cloud\Vision\V1\AnnotateFileRequest[] - - - - optionalArgs - [] - array - - - - Service that performs image detection and annotation for a batch of files. - Now only "application/pdf", "image/tiff" and "image/gif" are supported. - -This service will extract at most 5 (customers can specify which 5 in -AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each -file provided and perform detection and annotation for each image -extracted. - -Sample code: -``` -$imageAnnotatorClient = new ImageAnnotatorClient(); -try { - $requests = []; - $response = $imageAnnotatorClient->batchAnnotateFiles($requests); -} finally { - $imageAnnotatorClient->close(); -} -``` - - - - - - - - - - batchAnnotateImages - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient::batchAnnotateImages() - - \Google\Cloud\Vision\V1\Gapic\ImageAnnotatorGapicClient - requests - - \Google\Cloud\Vision\V1\AnnotateImageRequest[] - - - - optionalArgs - [] - array - - - - Run image detection and annotation for a batch of images. - Sample code: -``` -$imageAnnotatorClient = new ImageAnnotatorClient(); -try { - $requests = []; - $response = $imageAnnotatorClient->batchAnnotateImages($requests); -} finally { - $imageAnnotatorClient->close(); -} -``` - - - - - - - - - - annotateImageHelper - \Google\Cloud\Vision\VisionHelpersTrait::annotateImageHelper() - - \Google\Cloud\Vision\VisionHelpersTrait - callback - - callable - - - - requestClass - - \Google\Cloud\Vision\V1\AnnotateImageRequest|mixed - - - - image - - \Google\Cloud\Vision\Image|mixed - - - - features - - \Google\Cloud\Vision\V1\Feature[]|int[] - - - - optionalArgs - [] - array - - - - - - - - - - - - - - - - - buildFeatureList - \Google\Cloud\Vision\VisionHelpersTrait::buildFeatureList() - - \Google\Cloud\Vision\VisionHelpersTrait - featureClass - - string - - - - featureTypes - - \Google\Cloud\Vision\V1\Feature[]|int[] - - - - - - - - - - - - - - createImageHelper - \Google\Cloud\Vision\VisionHelpersTrait::createImageHelper() - - \Google\Cloud\Vision\VisionHelpersTrait - imageClass - - string - - - - imageSourceClass - - string - - - - imageInput - - string|resource|\Google\Cloud\Vision\Image|mixed - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ImageAnnotatorGrpcClient - \Google\Cloud\Vision\V1\ImageAnnotatorGrpcClient - - Service that performs Google Cloud Vision API detection tasks over client -images, such as face, landmark, logo, label, and text detection. The -ImageAnnotator service returns detected entities from the images. - - - - - \Grpc\BaseStub - - - - - __construct - \Google\Cloud\Vision\V1\ImageAnnotatorGrpcClient::__construct() - - - hostname - - string - - - - opts - - array - - - - channel - null - \Grpc\Channel - - - - - - - - - - - - - - BatchAnnotateImages - \Google\Cloud\Vision\V1\ImageAnnotatorGrpcClient::BatchAnnotateImages() - - - argument - - \Google\Cloud\Vision\V1\BatchAnnotateImagesRequest - - - - metadata - [] - array - - - - options - [] - array - - - - Run image detection and annotation for a batch of images. - - - - - - - - - - - BatchAnnotateFiles - \Google\Cloud\Vision\V1\ImageAnnotatorGrpcClient::BatchAnnotateFiles() - - - argument - - \Google\Cloud\Vision\V1\BatchAnnotateFilesRequest - - - - metadata - [] - array - - - - options - [] - array - - - - Service that performs image detection and annotation for a batch of files. - Now only "application/pdf", "image/tiff" and "image/gif" are supported. - -This service will extract at most 5 (customers can specify which 5 in -AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each -file provided and perform detection and annotation for each image -extracted. - - - - - - - - - - AsyncBatchAnnotateImages - \Google\Cloud\Vision\V1\ImageAnnotatorGrpcClient::AsyncBatchAnnotateImages() - - - argument - - \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest - - - - metadata - [] - array - - - - options - [] - array - - - - Run asynchronous image detection and annotation for a list of images. - Progress and results can be retrieved through the -`google.longrunning.Operations` interface. -`Operation.metadata` contains `OperationMetadata` (metadata). -`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - -This service will write image annotation outputs to json files in customer -GCS bucket, each json file containing BatchAnnotateImagesResponse proto. - - - - - - - - - - AsyncBatchAnnotateFiles - \Google\Cloud\Vision\V1\ImageAnnotatorGrpcClient::AsyncBatchAnnotateFiles() - - - argument - - \Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest - - - - metadata - [] - array - - - - options - [] - array - - - - Run asynchronous image detection and annotation for a list of generic -files, such as PDF files, which may contain multiple pages and multiple -images per page. Progress and results can be retrieved through the -`google.longrunning.Operations` interface. - `Operation.metadata` contains `OperationMetadata` (metadata). -`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ImageContext - \Google\Cloud\Vision\V1\ImageContext - - Image context and/or feature-specific parameters. - Generated from protobuf message <code>google.cloud.vision.v1.ImageContext</code> - - - - \Google\Protobuf\Internal\Message - - - - lat_long_rect - \Google\Cloud\Vision\V1\ImageContext::$lat_long_rect - null - - Not used. - Generated from protobuf field <code>.google.cloud.vision.v1.LatLongRect lat_long_rect = 1;</code> - - - - - - language_hints - \Google\Cloud\Vision\V1\ImageContext::$language_hints - - - List of languages to use for TEXT_DETECTION. In most cases, an empty value -yields the best results since it enables automatic language detection. For -languages based on the Latin alphabet, setting `language_hints` is not -needed. In rare cases, when the language of the text in the image is known, -setting a hint will help get better results (although it will be a -significant hindrance if the hint is wrong). Text detection returns an -error if one or more of the specified languages is not one of the -[supported languages](https://cloud.google.com/vision/docs/languages). - Generated from protobuf field <code>repeated string language_hints = 2;</code> - - - - - - crop_hints_params - \Google\Cloud\Vision\V1\ImageContext::$crop_hints_params - null - - Parameters for crop hints annotation request. - Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsParams crop_hints_params = 4;</code> - - - - - - product_search_params - \Google\Cloud\Vision\V1\ImageContext::$product_search_params - null - - Parameters for product search. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchParams product_search_params = 5;</code> - - - - - - web_detection_params - \Google\Cloud\Vision\V1\ImageContext::$web_detection_params - null - - Parameters for web detection. - Generated from protobuf field <code>.google.cloud.vision.v1.WebDetectionParams web_detection_params = 6;</code> - - - - - - text_detection_params - \Google\Cloud\Vision\V1\ImageContext::$text_detection_params - null - - Parameters for text detection and document text detection. - Generated from protobuf field <code>.google.cloud.vision.v1.TextDetectionParams text_detection_params = 12;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\ImageContext::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getLatLongRect - \Google\Cloud\Vision\V1\ImageContext::getLatLongRect() - - - Not used. - Generated from protobuf field <code>.google.cloud.vision.v1.LatLongRect lat_long_rect = 1;</code> - - - - - - - hasLatLongRect - \Google\Cloud\Vision\V1\ImageContext::hasLatLongRect() - - - - - - - - - - clearLatLongRect - \Google\Cloud\Vision\V1\ImageContext::clearLatLongRect() - - - - - - - - - - setLatLongRect - \Google\Cloud\Vision\V1\ImageContext::setLatLongRect() - - - var - - \Google\Cloud\Vision\V1\LatLongRect - - - - Not used. - Generated from protobuf field <code>.google.cloud.vision.v1.LatLongRect lat_long_rect = 1;</code> - - - - - - - - getLanguageHints - \Google\Cloud\Vision\V1\ImageContext::getLanguageHints() - - - List of languages to use for TEXT_DETECTION. In most cases, an empty value -yields the best results since it enables automatic language detection. For -languages based on the Latin alphabet, setting `language_hints` is not -needed. In rare cases, when the language of the text in the image is known, -setting a hint will help get better results (although it will be a -significant hindrance if the hint is wrong). Text detection returns an -error if one or more of the specified languages is not one of the -[supported languages](https://cloud.google.com/vision/docs/languages). - Generated from protobuf field <code>repeated string language_hints = 2;</code> - - - - - - - setLanguageHints - \Google\Cloud\Vision\V1\ImageContext::setLanguageHints() - - - var - - string[]|\Google\Protobuf\Internal\RepeatedField - - - - List of languages to use for TEXT_DETECTION. In most cases, an empty value -yields the best results since it enables automatic language detection. For -languages based on the Latin alphabet, setting `language_hints` is not -needed. In rare cases, when the language of the text in the image is known, -setting a hint will help get better results (although it will be a -significant hindrance if the hint is wrong). Text detection returns an -error if one or more of the specified languages is not one of the -[supported languages](https://cloud.google.com/vision/docs/languages). - Generated from protobuf field <code>repeated string language_hints = 2;</code> - - - - - - - - getCropHintsParams - \Google\Cloud\Vision\V1\ImageContext::getCropHintsParams() - - - Parameters for crop hints annotation request. - Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsParams crop_hints_params = 4;</code> - - - - - - - hasCropHintsParams - \Google\Cloud\Vision\V1\ImageContext::hasCropHintsParams() - - - - - - - - - - clearCropHintsParams - \Google\Cloud\Vision\V1\ImageContext::clearCropHintsParams() - - - - - - - - - - setCropHintsParams - \Google\Cloud\Vision\V1\ImageContext::setCropHintsParams() - - - var - - \Google\Cloud\Vision\V1\CropHintsParams - - - - Parameters for crop hints annotation request. - Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsParams crop_hints_params = 4;</code> - - - - - - - - getProductSearchParams - \Google\Cloud\Vision\V1\ImageContext::getProductSearchParams() - - - Parameters for product search. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchParams product_search_params = 5;</code> - - - - - - - hasProductSearchParams - \Google\Cloud\Vision\V1\ImageContext::hasProductSearchParams() - - - - - - - - - - clearProductSearchParams - \Google\Cloud\Vision\V1\ImageContext::clearProductSearchParams() - - - - - - - - - - setProductSearchParams - \Google\Cloud\Vision\V1\ImageContext::setProductSearchParams() - - - var - - \Google\Cloud\Vision\V1\ProductSearchParams - - - - Parameters for product search. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchParams product_search_params = 5;</code> - - - - - - - - getWebDetectionParams - \Google\Cloud\Vision\V1\ImageContext::getWebDetectionParams() - - - Parameters for web detection. - Generated from protobuf field <code>.google.cloud.vision.v1.WebDetectionParams web_detection_params = 6;</code> - - - - - - - hasWebDetectionParams - \Google\Cloud\Vision\V1\ImageContext::hasWebDetectionParams() - - - - - - - - - - clearWebDetectionParams - \Google\Cloud\Vision\V1\ImageContext::clearWebDetectionParams() - - - - - - - - - - setWebDetectionParams - \Google\Cloud\Vision\V1\ImageContext::setWebDetectionParams() - - - var - - \Google\Cloud\Vision\V1\WebDetectionParams - - - - Parameters for web detection. - Generated from protobuf field <code>.google.cloud.vision.v1.WebDetectionParams web_detection_params = 6;</code> - - - - - - - - getTextDetectionParams - \Google\Cloud\Vision\V1\ImageContext::getTextDetectionParams() - - - Parameters for text detection and document text detection. - Generated from protobuf field <code>.google.cloud.vision.v1.TextDetectionParams text_detection_params = 12;</code> - - - - - - - hasTextDetectionParams - \Google\Cloud\Vision\V1\ImageContext::hasTextDetectionParams() - - - - - - - - - - clearTextDetectionParams - \Google\Cloud\Vision\V1\ImageContext::clearTextDetectionParams() - - - - - - - - - - setTextDetectionParams - \Google\Cloud\Vision\V1\ImageContext::setTextDetectionParams() - - - var - - \Google\Cloud\Vision\V1\TextDetectionParams - - - - Parameters for text detection and document text detection. - Generated from protobuf field <code>.google.cloud.vision.v1.TextDetectionParams text_detection_params = 12;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ImageProperties - \Google\Cloud\Vision\V1\ImageProperties - - Stores image properties, such as dominant colors. - Generated from protobuf message <code>google.cloud.vision.v1.ImageProperties</code> - - - - \Google\Protobuf\Internal\Message - - - - dominant_colors - \Google\Cloud\Vision\V1\ImageProperties::$dominant_colors - null - - If present, dominant colors completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.DominantColorsAnnotation dominant_colors = 1;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\ImageProperties::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getDominantColors - \Google\Cloud\Vision\V1\ImageProperties::getDominantColors() - - - If present, dominant colors completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.DominantColorsAnnotation dominant_colors = 1;</code> - - - - - - - hasDominantColors - \Google\Cloud\Vision\V1\ImageProperties::hasDominantColors() - - - - - - - - - - clearDominantColors - \Google\Cloud\Vision\V1\ImageProperties::clearDominantColors() - - - - - - - - - - setDominantColors - \Google\Cloud\Vision\V1\ImageProperties::setDominantColors() - - - var - - \Google\Cloud\Vision\V1\DominantColorsAnnotation - - - - If present, dominant colors completed successfully. - Generated from protobuf field <code>.google.cloud.vision.v1.DominantColorsAnnotation dominant_colors = 1;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ImageSource - \Google\Cloud\Vision\V1\ImageSource - - External image source (Google Cloud Storage or web URL image location). - Generated from protobuf message <code>google.cloud.vision.v1.ImageSource</code> - - - - \Google\Protobuf\Internal\Message - - - - gcs_image_uri - \Google\Cloud\Vision\V1\ImageSource::$gcs_image_uri - '' - - **Use `image_uri` instead.** -The Google Cloud Storage URI of the form -`gs://bucket_name/object_name`. Object versioning is not supported. See -[Google Cloud Storage Request -URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. - Generated from protobuf field <code>string gcs_image_uri = 1;</code> - - - - - - image_uri - \Google\Cloud\Vision\V1\ImageSource::$image_uri - '' - - The URI of the source image. Can be either: -1. A Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. See - [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris) for more - info. - 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from - HTTP/HTTPS URLs, Google cannot guarantee that the request will be - completed. Your request may fail if the specified host denies the - request (e.g. due to request throttling or DOS prevention), or if Google - throttles requests to the site for abuse prevention. You should not - depend on externally-hosted images for production applications. -When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes -precedence. - -Generated from protobuf field <code>string image_uri = 2;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\ImageSource::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getGcsImageUri - \Google\Cloud\Vision\V1\ImageSource::getGcsImageUri() - - - **Use `image_uri` instead.** -The Google Cloud Storage URI of the form -`gs://bucket_name/object_name`. Object versioning is not supported. See -[Google Cloud Storage Request -URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. - Generated from protobuf field <code>string gcs_image_uri = 1;</code> - - - - - - - setGcsImageUri - \Google\Cloud\Vision\V1\ImageSource::setGcsImageUri() - - - var - - string - - - - **Use `image_uri` instead.** -The Google Cloud Storage URI of the form -`gs://bucket_name/object_name`. Object versioning is not supported. See -[Google Cloud Storage Request -URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. - Generated from protobuf field <code>string gcs_image_uri = 1;</code> - - - - - - - - getImageUri - \Google\Cloud\Vision\V1\ImageSource::getImageUri() - - - The URI of the source image. Can be either: -1. A Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. See - [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris) for more - info. - 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from - HTTP/HTTPS URLs, Google cannot guarantee that the request will be - completed. Your request may fail if the specified host denies the - request (e.g. due to request throttling or DOS prevention), or if Google - throttles requests to the site for abuse prevention. You should not - depend on externally-hosted images for production applications. -When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes -precedence. - -Generated from protobuf field <code>string image_uri = 2;</code> - - - - - - - setImageUri - \Google\Cloud\Vision\V1\ImageSource::setImageUri() - - - var - - string - - - - The URI of the source image. Can be either: -1. A Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. See - [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris) for more - info. - 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from - HTTP/HTTPS URLs, Google cannot guarantee that the request will be - completed. Your request may fail if the specified host denies the - request (e.g. due to request throttling or DOS prevention), or if Google - throttles requests to the site for abuse prevention. You should not - depend on externally-hosted images for production applications. -When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes -precedence. - -Generated from protobuf field <code>string image_uri = 2;</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ImportProductSetsGcsSource - \Google\Cloud\Vision\V1\ImportProductSetsGcsSource - - The Google Cloud Storage location for a csv file which preserves a list of -ImportProductSetRequests in each line. - Generated from protobuf message <code>google.cloud.vision.v1.ImportProductSetsGcsSource</code> - - - - \Google\Protobuf\Internal\Message - - - - csv_file_uri - \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::$csv_file_uri - '' - - The Google Cloud Storage URI of the input csv file. - The URI must start with `gs://`. -The format of the input csv file should be one image per line. -In each line, there are 8 columns. -1. image-uri -2. image-id -3. product-set-id -4. product-id -5. product-category -6. product-display-name -7. labels -8. bounding-poly -The `image-uri`, `product-set-id`, `product-id`, and `product-category` -columns are required. All other columns are optional. -If the `ProductSet` or `Product` specified by the `product-set-id` and -`product-id` values does not exist, then the system will create a new -`ProductSet` or `Product` for the image. In this case, the -`product-display-name` column refers to -[display_name][google.cloud.vision.v1.Product.display_name], the -`product-category` column refers to -[product_category][google.cloud.vision.v1.Product.product_category], and -the `labels` column refers to -[product_labels][google.cloud.vision.v1.Product.product_labels]. -The `image-id` column is optional but must be unique if provided. If it is -empty, the system will automatically assign a unique id to the image. -The `product-display-name` column is optional. If it is empty, the system -sets the [display_name][google.cloud.vision.v1.Product.display_name] field -for the product to a space (" "). You can update the `display_name` later -by using the API. -If a `Product` with the specified `product-id` already exists, then the -system ignores the `product-display-name`, `product-category`, and `labels` -columns. -The `labels` column (optional) is a line containing a list of -comma-separated key-value pairs, in the following format: - "key_1=value_1,key_2=value_2,...,key_n=value_n" -The `bounding-poly` column (optional) identifies one region of -interest from the image in the same manner as `CreateReferenceImage`. If -you do not specify the `bounding-poly` column, then the system will try to -detect regions of interest automatically. -At most one `bounding-poly` column is allowed per line. If the image -contains multiple regions of interest, add a line to the CSV file that -includes the same product information, and the `bounding-poly` values for -each region of interest. -The `bounding-poly` column must contain an even number of comma-separated -numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use -non-negative integers for absolute bounding polygons, and float values -in [0, 1] for normalized bounding polygons. -The system will resize the image if the image resolution is too -large to process (larger than 20MP). + + RIGHT_CHEEK_CENTER + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::RIGHT_CHEEK_CENTER + 36 + + Right cheek center. + Generated from protobuf enum <code>RIGHT_CHEEK_CENTER = 36;</code> + -Generated from protobuf field <code>string csv_file_uri = 1;</code> + + + + + valueToName + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::$valueToName + [self::UNKNOWN_LANDMARK => 'UNKNOWN_LANDMARK', self::LEFT_EYE => 'LEFT_EYE', self::RIGHT_EYE => 'RIGHT_EYE', self::LEFT_OF_LEFT_EYEBROW => 'LEFT_OF_LEFT_EYEBROW', self::RIGHT_OF_LEFT_EYEBROW => 'RIGHT_OF_LEFT_EYEBROW', self::LEFT_OF_RIGHT_EYEBROW => 'LEFT_OF_RIGHT_EYEBROW', self::RIGHT_OF_RIGHT_EYEBROW => 'RIGHT_OF_RIGHT_EYEBROW', self::MIDPOINT_BETWEEN_EYES => 'MIDPOINT_BETWEEN_EYES', self::NOSE_TIP => 'NOSE_TIP', self::UPPER_LIP => 'UPPER_LIP', self::LOWER_LIP => 'LOWER_LIP', self::MOUTH_LEFT => 'MOUTH_LEFT', self::MOUTH_RIGHT => 'MOUTH_RIGHT', self::MOUTH_CENTER => 'MOUTH_CENTER', self::NOSE_BOTTOM_RIGHT => 'NOSE_BOTTOM_RIGHT', self::NOSE_BOTTOM_LEFT => 'NOSE_BOTTOM_LEFT', self::NOSE_BOTTOM_CENTER => 'NOSE_BOTTOM_CENTER', self::LEFT_EYE_TOP_BOUNDARY => 'LEFT_EYE_TOP_BOUNDARY', self::LEFT_EYE_RIGHT_CORNER => 'LEFT_EYE_RIGHT_CORNER', self::LEFT_EYE_BOTTOM_BOUNDARY => 'LEFT_EYE_BOTTOM_BOUNDARY', self::LEFT_EYE_LEFT_CORNER => 'LEFT_EYE_LEFT_CORNER', self::RIGHT_EYE_TOP_BOUNDARY => 'RIGHT_EYE_TOP_BOUNDARY', self::RIGHT_EYE_RIGHT_CORNER => 'RIGHT_EYE_RIGHT_CORNER', self::RIGHT_EYE_BOTTOM_BOUNDARY => 'RIGHT_EYE_BOTTOM_BOUNDARY', self::RIGHT_EYE_LEFT_CORNER => 'RIGHT_EYE_LEFT_CORNER', self::LEFT_EYEBROW_UPPER_MIDPOINT => 'LEFT_EYEBROW_UPPER_MIDPOINT', self::RIGHT_EYEBROW_UPPER_MIDPOINT => 'RIGHT_EYEBROW_UPPER_MIDPOINT', self::LEFT_EAR_TRAGION => 'LEFT_EAR_TRAGION', self::RIGHT_EAR_TRAGION => 'RIGHT_EAR_TRAGION', self::LEFT_EYE_PUPIL => 'LEFT_EYE_PUPIL', self::RIGHT_EYE_PUPIL => 'RIGHT_EYE_PUPIL', self::FOREHEAD_GLABELLA => 'FOREHEAD_GLABELLA', self::CHIN_GNATHION => 'CHIN_GNATHION', self::CHIN_LEFT_GONION => 'CHIN_LEFT_GONION', self::CHIN_RIGHT_GONION => 'CHIN_RIGHT_GONION', self::LEFT_CHEEK_CENTER => 'LEFT_CHEEK_CENTER', self::RIGHT_CHEEK_CENTER => 'RIGHT_CHEEK_CENTER'] + + + - - __construct - \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::__construct() + + name + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::name() - - data - NULL - array + + value + + mixed - - Constructor. + + - - - - - - - getCsvFileUri - \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::getCsvFileUri() - - - The Google Cloud Storage URI of the input csv file. - The URI must start with `gs://`. -The format of the input csv file should be one image per line. -In each line, there are 8 columns. -1. image-uri -2. image-id -3. product-set-id -4. product-id -5. product-category -6. product-display-name -7. labels -8. bounding-poly -The `image-uri`, `product-set-id`, `product-id`, and `product-category` -columns are required. All other columns are optional. -If the `ProductSet` or `Product` specified by the `product-set-id` and -`product-id` values does not exist, then the system will create a new -`ProductSet` or `Product` for the image. In this case, the -`product-display-name` column refers to -[display_name][google.cloud.vision.v1.Product.display_name], the -`product-category` column refers to -[product_category][google.cloud.vision.v1.Product.product_category], and -the `labels` column refers to -[product_labels][google.cloud.vision.v1.Product.product_labels]. -The `image-id` column is optional but must be unique if provided. If it is -empty, the system will automatically assign a unique id to the image. -The `product-display-name` column is optional. If it is empty, the system -sets the [display_name][google.cloud.vision.v1.Product.display_name] field -for the product to a space (" "). You can update the `display_name` later -by using the API. -If a `Product` with the specified `product-id` already exists, then the -system ignores the `product-display-name`, `product-category`, and `labels` -columns. -The `labels` column (optional) is a line containing a list of -comma-separated key-value pairs, in the following format: - "key_1=value_1,key_2=value_2,...,key_n=value_n" -The `bounding-poly` column (optional) identifies one region of -interest from the image in the same manner as `CreateReferenceImage`. If -you do not specify the `bounding-poly` column, then the system will try to -detect regions of interest automatically. -At most one `bounding-poly` column is allowed per line. If the image -contains multiple regions of interest, add a line to the CSV file that -includes the same product information, and the `bounding-poly` values for -each region of interest. -The `bounding-poly` column must contain an even number of comma-separated -numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use -non-negative integers for absolute bounding polygons, and float values -in [0, 1] for normalized bounding polygons. -The system will resize the image if the image resolution is too -large to process (larger than 20MP). - -Generated from protobuf field <code>string csv_file_uri = 1;</code> - - + - - setCsvFileUri - \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::setCsvFileUri() + + value + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark\Type::value() - - var + + name - string + mixed - - The Google Cloud Storage URI of the input csv file. - The URI must start with `gs://`. -The format of the input csv file should be one image per line. -In each line, there are 8 columns. -1. image-uri -2. image-id -3. product-set-id -4. product-id -5. product-category -6. product-display-name -7. labels -8. bounding-poly -The `image-uri`, `product-set-id`, `product-id`, and `product-category` -columns are required. All other columns are optional. -If the `ProductSet` or `Product` specified by the `product-set-id` and -`product-id` values does not exist, then the system will create a new -`ProductSet` or `Product` for the image. In this case, the -`product-display-name` column refers to -[display_name][google.cloud.vision.v1.Product.display_name], the -`product-category` column refers to -[product_category][google.cloud.vision.v1.Product.product_category], and -the `labels` column refers to -[product_labels][google.cloud.vision.v1.Product.product_labels]. -The `image-id` column is optional but must be unique if provided. If it is -empty, the system will automatically assign a unique id to the image. -The `product-display-name` column is optional. If it is empty, the system -sets the [display_name][google.cloud.vision.v1.Product.display_name] field -for the product to a space (" "). You can update the `display_name` later -by using the API. -If a `Product` with the specified `product-id` already exists, then the -system ignores the `product-display-name`, `product-category`, and `labels` -columns. -The `labels` column (optional) is a line containing a list of -comma-separated key-value pairs, in the following format: - "key_1=value_1,key_2=value_2,...,key_n=value_n" -The `bounding-poly` column (optional) identifies one region of -interest from the image in the same manner as `CreateReferenceImage`. If -you do not specify the `bounding-poly` column, then the system will try to -detect regions of interest automatically. -At most one `bounding-poly` column is allowed per line. If the image -contains multiple regions of interest, add a line to the CSV file that -includes the same product information, and the `bounding-poly` values for -each region of interest. -The `bounding-poly` column must contain an even number of comma-separated -numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use -non-negative integers for absolute bounding polygons, and float values -in [0, 1] for normalized bounding polygons. -The system will resize the image if the image resolution is too -large to process (larger than 20MP). - -Generated from protobuf field <code>string csv_file_uri = 1;</code> - - - + + + + @@ -24550,7 +11461,7 @@ Generated from protobuf field <code>string csv_file_uri = 1;</code>< - + @@ -24562,18 +11473,19 @@ Generated from protobuf field <code>string csv_file_uri = 1;</code>< - + - - ImportProductSetsInputConfig - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig + + + Landmark + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark - The input content for the `ImportProductSets` method. - Generated from protobuf message <code>google.cloud.vision.v1.ImportProductSetsInputConfig</code> + A face-specific landmark (for example, a face feature). + Generated from protobuf message <code>google.cloud.vision.v1.FaceAnnotation.Landmark</code> \Google\Protobuf\Internal\Message - - source - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::$source - - - - + + type + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::$type + 0 + + Face landmark type. + Generated from protobuf field <code>.google.cloud.vision.v1.FaceAnnotation.Landmark.Type type = 3;</code> + + + + + + position + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::$position + null + + Face landmark position. + Generated from protobuf field <code>.google.cloud.vision.v1.Position position = 4;</code> - + __construct - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::__construct() + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::__construct() - + data - NULL + null array - + Constructor. + description="{ Optional. Data for populating the Message object. @type int $type Face landmark type. @type \Google\Cloud\Vision\V1\Position $position Face landmark position. }" + variable="data" type="array"/> + + + + + + getType + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::getType() + + + Face landmark type. + Generated from protobuf field <code>.google.cloud.vision.v1.FaceAnnotation.Landmark.Type type = 3;</code> + + + + + + + setType + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::setType() + + + var + + int + + + + Face landmark type. + Generated from protobuf field <code>.google.cloud.vision.v1.FaceAnnotation.Landmark.Type type = 3;</code> + + - - getGcsSource - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::getGcsSource() + + getPosition + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::getPosition() - - The Google Cloud Storage location for a csv file which preserves a list -of ImportProductSetRequests in each line. - Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsGcsSource gcs_source = 1;</code> + + Face landmark position. + Generated from protobuf field <code>.google.cloud.vision.v1.Position position = 4;</code> + type="\Google\Cloud\Vision\V1\Position|null"/> - - hasGcsSource - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::hasGcsSource() + + hasPosition + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::hasPosition() - + - - setGcsSource - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::setGcsSource() + + clearPosition + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::clearPosition() - + + + + + + + + + setPosition + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark::setPosition() + + var - \Google\Cloud\Vision\V1\ImportProductSetsGcsSource + \Google\Cloud\Vision\V1\Position - - The Google Cloud Storage location for a csv file which preserves a list -of ImportProductSetRequests in each line. - Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsGcsSource gcs_source = 1;</code> + + Face landmark position. + Generated from protobuf field <code>.google.cloud.vision.v1.Position position = 4;</code> + variable="var" type="\Google\Cloud\Vision\V1\Position"/> - - - - getSource - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::getSource() - - - - - - - @@ -24690,7 +11647,7 @@ of ImportProductSetRequests in each line. - + @@ -24708,12 +11665,13 @@ of ImportProductSetRequests in each line. + - ImportProductSetsRequest - \Google\Cloud\Vision\V1\ImportProductSetsRequest + FaceAnnotation + \Google\Cloud\Vision\V1\FaceAnnotation - Request message for the `ImportProductSets` method. - Generated from protobuf message <code>google.cloud.vision.v1.ImportProductSetsRequest</code> + A face annotation object contains the results of face detection. + Generated from protobuf message <code>google.cloud.vision.v1.FaceAnnotation</code> \Google\Protobuf\Internal\Message - - parent - \Google\Cloud\Vision\V1\ImportProductSetsRequest::$parent - '' - - Required. The project in which the ProductSets should be imported. - Format is `projects/PROJECT_ID/locations/LOC_ID`. + + bounding_poly + \Google\Cloud\Vision\V1\FaceAnnotation::$bounding_poly + null + + The bounding polygon around the face. The coordinates of the bounding box +are in the original image's scale. + The bounding box is computed to "frame" the face in accordance with human +expectations. It is based on the landmarker results. +Note that one or more x and/or y coordinates may not be generated in the +`BoundingPoly` (the polygon will be unbounded) if only a partial face +appears in the image to be annotated. -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> - - input_config - \Google\Cloud\Vision\V1\ImportProductSetsRequest::$input_config + + fd_bounding_poly + \Google\Cloud\Vision\V1\FaceAnnotation::$fd_bounding_poly null - - Required. The input content for the list of requests. - Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + The `fd_bounding_poly` bounding polygon is tighter than the +`boundingPoly`, and encloses only the skin part of the face. Typically, it +is used to eliminate the face from any image analysis that detects the +"amount of skin" visible in an image. It is not based on the +landmarker results, only on the initial face detection, hence +the <code>fd</code> (face detection) prefix. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;</code> + + + + + + landmarks + \Google\Cloud\Vision\V1\FaceAnnotation::$landmarks + + + Detected face landmarks. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;</code> + + + + + + roll_angle + \Google\Cloud\Vision\V1\FaceAnnotation::$roll_angle + 0.0 + + Roll angle, which indicates the amount of clockwise/anti-clockwise rotation +of the face relative to the image vertical about the axis perpendicular to +the face. Range [-180,180]. + Generated from protobuf field <code>float roll_angle = 4;</code> + + + + + + pan_angle + \Google\Cloud\Vision\V1\FaceAnnotation::$pan_angle + 0.0 + + Yaw angle, which indicates the leftward/rightward angle that the face is +pointing relative to the vertical plane perpendicular to the image. Range +[-180,180]. + Generated from protobuf field <code>float pan_angle = 5;</code> + + + + + + tilt_angle + \Google\Cloud\Vision\V1\FaceAnnotation::$tilt_angle + 0.0 + + Pitch angle, which indicates the upwards/downwards angle that the face is +pointing relative to the image's horizontal plane. Range [-180,180]. + Generated from protobuf field <code>float tilt_angle = 6;</code> + + + + + + detection_confidence + \Google\Cloud\Vision\V1\FaceAnnotation::$detection_confidence + 0.0 + + Detection confidence. Range [0, 1]. + Generated from protobuf field <code>float detection_confidence = 7;</code> + + + + + + landmarking_confidence + \Google\Cloud\Vision\V1\FaceAnnotation::$landmarking_confidence + 0.0 + + Face landmarking confidence. Range [0, 1]. + Generated from protobuf field <code>float landmarking_confidence = 8;</code> + + + + + + joy_likelihood + \Google\Cloud\Vision\V1\FaceAnnotation::$joy_likelihood + 0 + + Joy likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood joy_likelihood = 9;</code> + + + + + + sorrow_likelihood + \Google\Cloud\Vision\V1\FaceAnnotation::$sorrow_likelihood + 0 + + Sorrow likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;</code> + + + + + + anger_likelihood + \Google\Cloud\Vision\V1\FaceAnnotation::$anger_likelihood + 0 + + Anger likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood anger_likelihood = 11;</code> + + + + + + surprise_likelihood + \Google\Cloud\Vision\V1\FaceAnnotation::$surprise_likelihood + 0 + + Surprise likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;</code> + + + + + + under_exposed_likelihood + \Google\Cloud\Vision\V1\FaceAnnotation::$under_exposed_likelihood + 0 + + Under-exposed likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;</code> + + + + + + blurred_likelihood + \Google\Cloud\Vision\V1\FaceAnnotation::$blurred_likelihood + 0 + + Blurred likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;</code> + + + + + + headwear_likelihood + \Google\Cloud\Vision\V1\FaceAnnotation::$headwear_likelihood + 0 + + Headwear likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;</code> - - build - \Google\Cloud\Vision\V1\ImportProductSetsRequest::build() - - - parent - - string - - - - inputConfig - - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig - - - - - - - - - - - - - - + __construct - \Google\Cloud\Vision\V1\ImportProductSetsRequest::__construct() + \Google\Cloud\Vision\V1\FaceAnnotation::__construct() - + data - NULL + null array - + Constructor. - - getParent - \Google\Cloud\Vision\V1\ImportProductSetsRequest::getParent() + + getBoundingPoly + \Google\Cloud\Vision\V1\FaceAnnotation::getBoundingPoly() - - Required. The project in which the ProductSets should be imported. - Format is `projects/PROJECT_ID/locations/LOC_ID`. + + The bounding polygon around the face. The coordinates of the bounding box +are in the original image's scale. + The bounding box is computed to "frame" the face in accordance with human +expectations. It is based on the landmarker results. +Note that one or more x and/or y coordinates may not be generated in the +`BoundingPoly` (the polygon will be unbounded) if only a partial face +appears in the image to be annotated. -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + type="\Google\Cloud\Vision\V1\BoundingPoly|null"/> - - setParent - \Google\Cloud\Vision\V1\ImportProductSetsRequest::setParent() + + hasBoundingPoly + \Google\Cloud\Vision\V1\FaceAnnotation::hasBoundingPoly() - + + + + + + + + + clearBoundingPoly + \Google\Cloud\Vision\V1\FaceAnnotation::clearBoundingPoly() + + + + + + + + + + setBoundingPoly + \Google\Cloud\Vision\V1\FaceAnnotation::setBoundingPoly() + + var - string + \Google\Cloud\Vision\V1\BoundingPoly - - Required. The project in which the ProductSets should be imported. - Format is `projects/PROJECT_ID/locations/LOC_ID`. + + The bounding polygon around the face. The coordinates of the bounding box +are in the original image's scale. + The bounding box is computed to "frame" the face in accordance with human +expectations. It is based on the landmarker results. +Note that one or more x and/or y coordinates may not be generated in the +`BoundingPoly` (the polygon will be unbounded) if only a partial face +appears in the image to be annotated. -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> - - getInputConfig - \Google\Cloud\Vision\V1\ImportProductSetsRequest::getInputConfig() + + getFdBoundingPoly + \Google\Cloud\Vision\V1\FaceAnnotation::getFdBoundingPoly() - - Required. The input content for the list of requests. - Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + The `fd_bounding_poly` bounding polygon is tighter than the +`boundingPoly`, and encloses only the skin part of the face. Typically, it +is used to eliminate the face from any image analysis that detects the +"amount of skin" visible in an image. It is not based on the +landmarker results, only on the initial face detection, hence +the <code>fd</code> (face detection) prefix. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;</code> + type="\Google\Cloud\Vision\V1\BoundingPoly|null"/> - - hasInputConfig - \Google\Cloud\Vision\V1\ImportProductSetsRequest::hasInputConfig() + + hasFdBoundingPoly + \Google\Cloud\Vision\V1\FaceAnnotation::hasFdBoundingPoly() - + - - clearInputConfig - \Google\Cloud\Vision\V1\ImportProductSetsRequest::clearInputConfig() + + clearFdBoundingPoly + \Google\Cloud\Vision\V1\FaceAnnotation::clearFdBoundingPoly() - + - - setInputConfig - \Google\Cloud\Vision\V1\ImportProductSetsRequest::setInputConfig() - - - var - - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig - - - - Required. The input content for the list of requests. - Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ImportProductSetsResponse - \Google\Cloud\Vision\V1\ImportProductSetsResponse - - Response message for the `ImportProductSets` method. - This message is returned by the -[google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] -method in the returned -[google.longrunning.Operation.response][google.longrunning.Operation.response] -field. - -Generated from protobuf message <code>google.cloud.vision.v1.ImportProductSetsResponse</code> - - - - \Google\Protobuf\Internal\Message - - - - reference_images - \Google\Cloud\Vision\V1\ImportProductSetsResponse::$reference_images - - - The list of reference_images that are imported successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> - - - - - - statuses - \Google\Cloud\Vision\V1\ImportProductSetsResponse::$statuses - - - The rpc status for each ImportProductSet request, including both successes -and errors. - The number of statuses here matches the number of lines in the csv file, -and statuses[i] stores the success or failure status of processing the i-th -line of the csv, starting from line 0. - -Generated from protobuf field <code>repeated .google.rpc.Status statuses = 2;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\ImportProductSetsResponse::__construct() + + setFdBoundingPoly + \Google\Cloud\Vision\V1\FaceAnnotation::setFdBoundingPoly() - - data - NULL - array + + var + + \Google\Cloud\Vision\V1\BoundingPoly - - Constructor. - + + The `fd_bounding_poly` bounding polygon is tighter than the +`boundingPoly`, and encloses only the skin part of the face. Typically, it +is used to eliminate the face from any image analysis that detects the +"amount of skin" visible in an image. It is not based on the +landmarker results, only on the initial face detection, hence +the <code>fd</code> (face detection) prefix. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> + - - getReferenceImages - \Google\Cloud\Vision\V1\ImportProductSetsResponse::getReferenceImages() + + getLandmarks + \Google\Cloud\Vision\V1\FaceAnnotation::getLandmarks() - - The list of reference_images that are imported successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> + + Detected face landmarks. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\FaceAnnotation\Landmark>"/> - - setReferenceImages - \Google\Cloud\Vision\V1\ImportProductSetsResponse::setReferenceImages() + + setLandmarks + \Google\Cloud\Vision\V1\FaceAnnotation::setLandmarks() - + var - \Google\Cloud\Vision\V1\ReferenceImage[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\FaceAnnotation\Landmark[] - - The list of reference_images that are imported successfully. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> + + Detected face landmarks. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;</code> + variable="var" type="\Google\Cloud\Vision\V1\FaceAnnotation\Landmark[]"/> - - getStatuses - \Google\Cloud\Vision\V1\ImportProductSetsResponse::getStatuses() + + getRollAngle + \Google\Cloud\Vision\V1\FaceAnnotation::getRollAngle() - - The rpc status for each ImportProductSet request, including both successes -and errors. - The number of statuses here matches the number of lines in the csv file, -and statuses[i] stores the success or failure status of processing the i-th -line of the csv, starting from line 0. - -Generated from protobuf field <code>repeated .google.rpc.Status statuses = 2;</code> + + Roll angle, which indicates the amount of clockwise/anti-clockwise rotation +of the face relative to the image vertical about the axis perpendicular to +the face. Range [-180,180]. + Generated from protobuf field <code>float roll_angle = 4;</code> + type="float"/> - - setStatuses - \Google\Cloud\Vision\V1\ImportProductSetsResponse::setStatuses() + + setRollAngle + \Google\Cloud\Vision\V1\FaceAnnotation::setRollAngle() - + var - \Google\Rpc\Status[]|\Google\Protobuf\Internal\RepeatedField + float - - The rpc status for each ImportProductSet request, including both successes -and errors. - The number of statuses here matches the number of lines in the csv file, -and statuses[i] stores the success or failure status of processing the i-th -line of the csv, starting from line 0. - -Generated from protobuf field <code>repeated .google.rpc.Status statuses = 2;</code> + + Roll angle, which indicates the amount of clockwise/anti-clockwise rotation +of the face relative to the image vertical about the axis perpendicular to +the face. Range [-180,180]. + Generated from protobuf field <code>float roll_angle = 4;</code> + variable="var" type="float"/> - - - - - - - - - - - - - - - - - - - - - - - InputConfig - \Google\Cloud\Vision\V1\InputConfig - - The desired input location and metadata. - Generated from protobuf message <code>google.cloud.vision.v1.InputConfig</code> + + getPanAngle + \Google\Cloud\Vision\V1\FaceAnnotation::getPanAngle() + + + Yaw angle, which indicates the leftward/rightward angle that the face is +pointing relative to the vertical plane perpendicular to the image. Range +[-180,180]. + Generated from protobuf field <code>float pan_angle = 5;</code> + name="return" + description="" + type="float"/> - \Google\Protobuf\Internal\Message - - - - gcs_source - \Google\Cloud\Vision\V1\InputConfig::$gcs_source - null - - The Google Cloud Storage location to read the input from. - Generated from protobuf field <code>.google.cloud.vision.v1.GcsSource gcs_source = 1;</code> - - - - - - content - \Google\Cloud\Vision\V1\InputConfig::$content - '' - - File content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary -representation, whereas JSON representations use base64. -Currently, this field only works for BatchAnnotateFiles requests. It does -not work for AsyncBatchAnnotateFiles requests. - -Generated from protobuf field <code>bytes content = 3;</code> - - - - - - mime_type - \Google\Cloud\Vision\V1\InputConfig::$mime_type - '' - - The type of the file. Currently only "application/pdf", "image/tiff" and -"image/gif" are supported. Wildcards are not supported. - Generated from protobuf field <code>string mime_type = 2;</code> - - - + - - - __construct - \Google\Cloud\Vision\V1\InputConfig::__construct() + + setPanAngle + \Google\Cloud\Vision\V1\FaceAnnotation::setPanAngle() - - data - NULL - array + + var + + float - - Constructor. - + + Yaw angle, which indicates the leftward/rightward angle that the face is +pointing relative to the vertical plane perpendicular to the image. Range +[-180,180]. + Generated from protobuf field <code>float pan_angle = 5;</code> + description="" + variable="var" type="float"/> + - - getGcsSource - \Google\Cloud\Vision\V1\InputConfig::getGcsSource() + + getTiltAngle + \Google\Cloud\Vision\V1\FaceAnnotation::getTiltAngle() - - The Google Cloud Storage location to read the input from. - Generated from protobuf field <code>.google.cloud.vision.v1.GcsSource gcs_source = 1;</code> + + Pitch angle, which indicates the upwards/downwards angle that the face is +pointing relative to the image's horizontal plane. Range [-180,180]. + Generated from protobuf field <code>float tilt_angle = 6;</code> + type="float"/> - - hasGcsSource - \Google\Cloud\Vision\V1\InputConfig::hasGcsSource() + + setTiltAngle + \Google\Cloud\Vision\V1\FaceAnnotation::setTiltAngle() - - - - + + var + + float + - + + Pitch angle, which indicates the upwards/downwards angle that the face is +pointing relative to the image's horizontal plane. Range [-180,180]. + Generated from protobuf field <code>float tilt_angle = 6;</code> + + + - - clearGcsSource - \Google\Cloud\Vision\V1\InputConfig::clearGcsSource() + + + + getDetectionConfidence + \Google\Cloud\Vision\V1\FaceAnnotation::getDetectionConfidence() - - - - + + Detection confidence. Range [0, 1]. + Generated from protobuf field <code>float detection_confidence = 7;</code> + + - - setGcsSource - \Google\Cloud\Vision\V1\InputConfig::setGcsSource() + + setDetectionConfidence + \Google\Cloud\Vision\V1\FaceAnnotation::setDetectionConfidence() - + var - \Google\Cloud\Vision\V1\GcsSource + float - - The Google Cloud Storage location to read the input from. - Generated from protobuf field <code>.google.cloud.vision.v1.GcsSource gcs_source = 1;</code> + + Detection confidence. Range [0, 1]. + Generated from protobuf field <code>float detection_confidence = 7;</code> + variable="var" type="float"/> - - getContent - \Google\Cloud\Vision\V1\InputConfig::getContent() + + getLandmarkingConfidence + \Google\Cloud\Vision\V1\FaceAnnotation::getLandmarkingConfidence() - - File content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary -representation, whereas JSON representations use base64. -Currently, this field only works for BatchAnnotateFiles requests. It does -not work for AsyncBatchAnnotateFiles requests. - -Generated from protobuf field <code>bytes content = 3;</code> + + Face landmarking confidence. Range [0, 1]. + Generated from protobuf field <code>float landmarking_confidence = 8;</code> + type="float"/> - - setContent - \Google\Cloud\Vision\V1\InputConfig::setContent() + + setLandmarkingConfidence + \Google\Cloud\Vision\V1\FaceAnnotation::setLandmarkingConfidence() - + var - string + float - - File content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary -representation, whereas JSON representations use base64. -Currently, this field only works for BatchAnnotateFiles requests. It does -not work for AsyncBatchAnnotateFiles requests. - -Generated from protobuf field <code>bytes content = 3;</code> + + Face landmarking confidence. Range [0, 1]. + Generated from protobuf field <code>float landmarking_confidence = 8;</code> + variable="var" type="float"/> - - getMimeType - \Google\Cloud\Vision\V1\InputConfig::getMimeType() + + getJoyLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::getJoyLikelihood() - - The type of the file. Currently only "application/pdf", "image/tiff" and -"image/gif" are supported. Wildcards are not supported. - Generated from protobuf field <code>string mime_type = 2;</code> + + Joy likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood joy_likelihood = 9;</code> + type="int"/> - - setMimeType - \Google\Cloud\Vision\V1\InputConfig::setMimeType() + + setJoyLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::setJoyLikelihood() - + var - string + int - - The type of the file. Currently only "application/pdf", "image/tiff" and -"image/gif" are supported. Wildcards are not supported. - Generated from protobuf field <code>string mime_type = 2;</code> + + Joy likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood joy_likelihood = 9;</code> + variable="var" type="int"/> - - - - - - - - - - - - - - - - - - - - - - - LatLongRect - \Google\Cloud\Vision\V1\LatLongRect - - Rectangle determined by min and max `LatLng` pairs. - Generated from protobuf message <code>google.cloud.vision.v1.LatLongRect</code> + + getSorrowLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::getSorrowLikelihood() + + + Sorrow likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;</code> + name="return" + description="" + type="int"/> - \Google\Protobuf\Internal\Message - - - - min_lat_lng - \Google\Cloud\Vision\V1\LatLongRect::$min_lat_lng - null - - Min lat/long pair. - Generated from protobuf field <code>.google.type.LatLng min_lat_lng = 1;</code> - - - - - - max_lat_lng - \Google\Cloud\Vision\V1\LatLongRect::$max_lat_lng - null - - Max lat/long pair. - Generated from protobuf field <code>.google.type.LatLng max_lat_lng = 2;</code> - - - + - - - __construct - \Google\Cloud\Vision\V1\LatLongRect::__construct() + + setSorrowLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::setSorrowLikelihood() - - data - NULL - array + + var + + int - - Constructor. - + + Sorrow likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;</code> + description="" + variable="var" type="int"/> + - - getMinLatLng - \Google\Cloud\Vision\V1\LatLongRect::getMinLatLng() + + getAngerLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::getAngerLikelihood() - - Min lat/long pair. - Generated from protobuf field <code>.google.type.LatLng min_lat_lng = 1;</code> + + Anger likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood anger_likelihood = 11;</code> + type="int"/> - - hasMinLatLng - \Google\Cloud\Vision\V1\LatLongRect::hasMinLatLng() + + setAngerLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::setAngerLikelihood() - - - - + + var + + int + + + + Anger likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood anger_likelihood = 11;</code> + + + - - clearMinLatLng - \Google\Cloud\Vision\V1\LatLongRect::clearMinLatLng() - - - - - + + getSurpriseLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::getSurpriseLikelihood() + + + Surprise likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;</code> + + - - setMinLatLng - \Google\Cloud\Vision\V1\LatLongRect::setMinLatLng() + + setSurpriseLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::setSurpriseLikelihood() - + var - \Google\Type\LatLng + int - - Min lat/long pair. - Generated from protobuf field <code>.google.type.LatLng min_lat_lng = 1;</code> + + Surprise likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;</code> + variable="var" type="int"/> - - getMaxLatLng - \Google\Cloud\Vision\V1\LatLongRect::getMaxLatLng() + + getUnderExposedLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::getUnderExposedLikelihood() - - Max lat/long pair. - Generated from protobuf field <code>.google.type.LatLng max_lat_lng = 2;</code> + + Under-exposed likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;</code> + type="int"/> - - hasMaxLatLng - \Google\Cloud\Vision\V1\LatLongRect::hasMaxLatLng() + + setUnderExposedLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::setUnderExposedLikelihood() - - - - + + var + + int + + + + Under-exposed likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;</code> + + + - - clearMaxLatLng - \Google\Cloud\Vision\V1\LatLongRect::clearMaxLatLng() + + getBlurredLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::getBlurredLikelihood() - - - - + + Blurred likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;</code> + + - - setMaxLatLng - \Google\Cloud\Vision\V1\LatLongRect::setMaxLatLng() + + setBlurredLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::setBlurredLikelihood() - + var - \Google\Type\LatLng + int - - Max lat/long pair. - Generated from protobuf field <code>.google.type.LatLng max_lat_lng = 2;</code> + + Blurred likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;</code> + variable="var" type="int"/> - - - - - - - - - - - - - - - - - - - - - - - Likelihood - \Google\Cloud\Vision\V1\Likelihood - - A bucketized representation of likelihood, which is intended to give clients -highly stable results across model upgrades. - Protobuf type <code>google.cloud.vision.v1.Likelihood</code> + + getHeadwearLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::getHeadwearLikelihood() + + + Headwear likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;</code> + name="return" + description="" + type="int"/> - - - - UNKNOWN - \Google\Cloud\Vision\V1\Likelihood::UNKNOWN - 0 - - Unknown likelihood. - Generated from protobuf enum <code>UNKNOWN = 0;</code> - - - - - - VERY_UNLIKELY - \Google\Cloud\Vision\V1\Likelihood::VERY_UNLIKELY - 1 - - It is very unlikely. - Generated from protobuf enum <code>VERY_UNLIKELY = 1;</code> - - - - - - UNLIKELY - \Google\Cloud\Vision\V1\Likelihood::UNLIKELY - 2 - - It is unlikely. - Generated from protobuf enum <code>UNLIKELY = 2;</code> - - - - - - POSSIBLE - \Google\Cloud\Vision\V1\Likelihood::POSSIBLE - 3 - - It is possible. - Generated from protobuf enum <code>POSSIBLE = 3;</code> - - - - - - LIKELY - \Google\Cloud\Vision\V1\Likelihood::LIKELY - 4 - - It is likely. - Generated from protobuf enum <code>LIKELY = 4;</code> - - - - - - VERY_LIKELY - \Google\Cloud\Vision\V1\Likelihood::VERY_LIKELY - 5 - - It is very likely. - Generated from protobuf enum <code>VERY_LIKELY = 5;</code> - - - - - - - valueToName - \Google\Cloud\Vision\V1\Likelihood::$valueToName - [self::UNKNOWN => 'UNKNOWN', self::VERY_UNLIKELY => 'VERY_UNLIKELY', self::UNLIKELY => 'UNLIKELY', self::POSSIBLE => 'POSSIBLE', self::LIKELY => 'LIKELY', self::VERY_LIKELY => 'VERY_LIKELY'] - - - - - - - - - - name - \Google\Cloud\Vision\V1\Likelihood::name() - - - value - - mixed - - - - - - - - - value - \Google\Cloud\Vision\V1\Likelihood::value() + + setHeadwearLikelihood + \Google\Cloud\Vision\V1\FaceAnnotation::setHeadwearLikelihood() - - name + + var - mixed + int - - - - + + Headwear likelihood. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;</code> + + + @@ -25717,7 +12569,7 @@ highly stable results across model upgrades. - + @@ -25729,234 +12581,219 @@ highly stable results across model upgrades. - + - - ListProductSetsRequest - \Google\Cloud\Vision\V1\ListProductSetsRequest - - Request message for the `ListProductSets` method. - Generated from protobuf message <code>google.cloud.vision.v1.ListProductSetsRequest</code> + + + Type + \Google\Cloud\Vision\V1\Feature\Type + + Type of Google Cloud Vision API feature to be extracted. + Protobuf type <code>google.cloud.vision.v1.Feature.Type</code> - \Google\Protobuf\Internal\Message - - - parent - \Google\Cloud\Vision\V1\ListProductSetsRequest::$parent - '' - - Required. The project from which ProductSets should be listed. - Format is `projects/PROJECT_ID/locations/LOC_ID`. + + + TYPE_UNSPECIFIED + \Google\Cloud\Vision\V1\Feature\Type::TYPE_UNSPECIFIED + 0 + + Unspecified feature type. + Generated from protobuf enum <code>TYPE_UNSPECIFIED = 0;</code> + -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + FACE_DETECTION + \Google\Cloud\Vision\V1\Feature\Type::FACE_DETECTION + 1 + + Run face detection. + Generated from protobuf enum <code>FACE_DETECTION = 1;</code> - + - - page_size - \Google\Cloud\Vision\V1\ListProductSetsRequest::$page_size - 0 - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> + + LANDMARK_DETECTION + \Google\Cloud\Vision\V1\Feature\Type::LANDMARK_DETECTION + 2 + + Run landmark detection. + Generated from protobuf enum <code>LANDMARK_DETECTION = 2;</code> - + - - page_token - \Google\Cloud\Vision\V1\ListProductSetsRequest::$page_token - '' - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string page_token = 3;</code> + + LOGO_DETECTION + \Google\Cloud\Vision\V1\Feature\Type::LOGO_DETECTION + 3 + + Run logo detection. + Generated from protobuf enum <code>LOGO_DETECTION = 3;</code> - + - - - build - \Google\Cloud\Vision\V1\ListProductSetsRequest::build() - - - parent - - string - + + LABEL_DETECTION + \Google\Cloud\Vision\V1\Feature\Type::LABEL_DETECTION + 4 + + Run label detection. + Generated from protobuf enum <code>LABEL_DETECTION = 4;</code> + - - - - - - - + - + + TEXT_DETECTION + \Google\Cloud\Vision\V1\Feature\Type::TEXT_DETECTION + 5 + + Run text detection / optical character recognition (OCR). Text detection +is optimized for areas of text within a larger image; if the image is +a document, use `DOCUMENT_TEXT_DETECTION` instead. + Generated from protobuf enum <code>TEXT_DETECTION = 5;</code> + - - __construct - \Google\Cloud\Vision\V1\ListProductSetsRequest::__construct() - - - data - NULL - array - + - - Constructor. - - - + + DOCUMENT_TEXT_DETECTION + \Google\Cloud\Vision\V1\Feature\Type::DOCUMENT_TEXT_DETECTION + 11 + + Run dense text document OCR. Takes precedence when both +`DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present. + Generated from protobuf enum <code>DOCUMENT_TEXT_DETECTION = 11;</code> + - + - - getParent - \Google\Cloud\Vision\V1\ListProductSetsRequest::getParent() - - - Required. The project from which ProductSets should be listed. - Format is `projects/PROJECT_ID/locations/LOC_ID`. + + SAFE_SEARCH_DETECTION + \Google\Cloud\Vision\V1\Feature\Type::SAFE_SEARCH_DETECTION + 6 + + Run Safe Search to detect potentially unsafe +or undesirable content. + Generated from protobuf enum <code>SAFE_SEARCH_DETECTION = 6;</code> + -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - + - + + IMAGE_PROPERTIES + \Google\Cloud\Vision\V1\Feature\Type::IMAGE_PROPERTIES + 7 + + Compute a set of image properties, such as the +image's dominant colors. + Generated from protobuf enum <code>IMAGE_PROPERTIES = 7;</code> + - - setParent - \Google\Cloud\Vision\V1\ListProductSetsRequest::setParent() - - - var - - string - + - - Required. The project from which ProductSets should be listed. - Format is `projects/PROJECT_ID/locations/LOC_ID`. + + CROP_HINTS + \Google\Cloud\Vision\V1\Feature\Type::CROP_HINTS + 9 + + Run crop hints. + Generated from protobuf enum <code>CROP_HINTS = 9;</code> + -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - + - + + WEB_DETECTION + \Google\Cloud\Vision\V1\Feature\Type::WEB_DETECTION + 10 + + Run web detection. + Generated from protobuf enum <code>WEB_DETECTION = 10;</code> + + + + + + PRODUCT_SEARCH + \Google\Cloud\Vision\V1\Feature\Type::PRODUCT_SEARCH + 12 + + Run Product Search. + Generated from protobuf enum <code>PRODUCT_SEARCH = 12;</code> + + + + + + OBJECT_LOCALIZATION + \Google\Cloud\Vision\V1\Feature\Type::OBJECT_LOCALIZATION + 19 + + Run localizer for object detection. + Generated from protobuf enum <code>OBJECT_LOCALIZATION = 19;</code> + + + - - getPageSize - \Google\Cloud\Vision\V1\ListProductSetsRequest::getPageSize() - - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> - - + + + valueToName + \Google\Cloud\Vision\V1\Feature\Type::$valueToName + [self::TYPE_UNSPECIFIED => 'TYPE_UNSPECIFIED', self::FACE_DETECTION => 'FACE_DETECTION', self::LANDMARK_DETECTION => 'LANDMARK_DETECTION', self::LOGO_DETECTION => 'LOGO_DETECTION', self::LABEL_DETECTION => 'LABEL_DETECTION', self::TEXT_DETECTION => 'TEXT_DETECTION', self::DOCUMENT_TEXT_DETECTION => 'DOCUMENT_TEXT_DETECTION', self::SAFE_SEARCH_DETECTION => 'SAFE_SEARCH_DETECTION', self::IMAGE_PROPERTIES => 'IMAGE_PROPERTIES', self::CROP_HINTS => 'CROP_HINTS', self::WEB_DETECTION => 'WEB_DETECTION', self::PRODUCT_SEARCH => 'PRODUCT_SEARCH', self::OBJECT_LOCALIZATION => 'OBJECT_LOCALIZATION'] + + + + - + - - setPageSize - \Google\Cloud\Vision\V1\ListProductSetsRequest::setPageSize() + + + name + \Google\Cloud\Vision\V1\Feature\Type::name() - - var + + value - int + mixed - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> - - - - - - - - getPageToken - \Google\Cloud\Vision\V1\ListProductSetsRequest::getPageToken() - - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string page_token = 3;</code> - - + + + + - - setPageToken - \Google\Cloud\Vision\V1\ListProductSetsRequest::setPageToken() + + value + \Google\Cloud\Vision\V1\Feature\Type::value() - - var + + name - string + mixed - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string page_token = 3;</code> - - - + + + + @@ -25966,7 +12803,7 @@ Generated from protobuf field <code>string parent = 1 [(.google.api.field_ - + @@ -25984,12 +12821,15 @@ Generated from protobuf field <code>string parent = 1 [(.google.api.field_ - - ListProductSetsResponse - \Google\Cloud\Vision\V1\ListProductSetsResponse - - Response message for the `ListProductSets` method. - Generated from protobuf message <code>google.cloud.vision.v1.ListProductSetsResponse</code> + + + Feature + \Google\Cloud\Vision\V1\Feature + + The type of Google Cloud Vision API detection to perform, and the maximum +number of results to return for that type. Multiple `Feature` objects can +be specified in the `features` list. + Generated from protobuf message <code>google.cloud.vision.v1.Feature</code> \Google\Protobuf\Internal\Message - - product_sets - \Google\Cloud\Vision\V1\ListProductSetsResponse::$product_sets - - - List of ProductSets. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSet product_sets = 1;</code> + + type + \Google\Cloud\Vision\V1\Feature::$type + 0 + + The feature type. + Generated from protobuf field <code>.google.cloud.vision.v1.Feature.Type type = 1;</code> - - next_page_token - \Google\Cloud\Vision\V1\ListProductSetsResponse::$next_page_token + + max_results + \Google\Cloud\Vision\V1\Feature::$max_results + 0 + + Maximum number of results of this type. Does not apply to +`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. + Generated from protobuf field <code>int32 max_results = 2;</code> + + + + + + model + \Google\Cloud\Vision\V1\Feature::$model '' - - Token to retrieve the next page of results, or empty if there are no more -results in the list. - Generated from protobuf field <code>string next_page_token = 2;</code> + + Model to use for the feature. + Supported values: "builtin/stable" (the default if unset) and +"builtin/latest". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also +support "builtin/weekly" for the bleeding edge release updated weekly. + +Generated from protobuf field <code>string model = 3;</code> - + __construct - \Google\Cloud\Vision\V1\ListProductSetsResponse::__construct() + \Google\Cloud\Vision\V1\Feature::__construct() - + data - NULL + null array - + Constructor. - - getProductSets - \Google\Cloud\Vision\V1\ListProductSetsResponse::getProductSets() + + getType + \Google\Cloud\Vision\V1\Feature::getType() - - List of ProductSets. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSet product_sets = 1;</code> + + The feature type. + Generated from protobuf field <code>.google.cloud.vision.v1.Feature.Type type = 1;</code> + type="int"/> - - setProductSets - \Google\Cloud\Vision\V1\ListProductSetsResponse::setProductSets() + + setType + \Google\Cloud\Vision\V1\Feature::setType() - + var - \Google\Cloud\Vision\V1\ProductSet[]|\Google\Protobuf\Internal\RepeatedField + int - - List of ProductSets. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSet product_sets = 1;</code> + + The feature type. + Generated from protobuf field <code>.google.cloud.vision.v1.Feature.Type type = 1;</code> + variable="var" type="int"/> - - getNextPageToken - \Google\Cloud\Vision\V1\ListProductSetsResponse::getNextPageToken() + + getMaxResults + \Google\Cloud\Vision\V1\Feature::getMaxResults() - - Token to retrieve the next page of results, or empty if there are no more -results in the list. - Generated from protobuf field <code>string next_page_token = 2;</code> + + Maximum number of results of this type. Does not apply to +`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. + Generated from protobuf field <code>int32 max_results = 2;</code> + + + + + + + setMaxResults + \Google\Cloud\Vision\V1\Feature::setMaxResults() + + + var + + int + + + + Maximum number of results of this type. Does not apply to +`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. + Generated from protobuf field <code>int32 max_results = 2;</code> + + + + + + + + getModel + \Google\Cloud\Vision\V1\Feature::getModel() + + + Model to use for the feature. + Supported values: "builtin/stable" (the default if unset) and +"builtin/latest". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also +support "builtin/weekly" for the bleeding edge release updated weekly. + +Generated from protobuf field <code>string model = 3;</code> - - setNextPageToken - \Google\Cloud\Vision\V1\ListProductSetsResponse::setNextPageToken() + + setModel + \Google\Cloud\Vision\V1\Feature::setModel() - + var string - - Token to retrieve the next page of results, or empty if there are no more -results in the list. - Generated from protobuf field <code>string next_page_token = 2;</code> + + Model to use for the feature. + Supported values: "builtin/stable" (the default if unset) and +"builtin/latest". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also +support "builtin/weekly" for the bleeding edge release updated weekly. + +Generated from protobuf field <code>string model = 3;</code> - + @@ -26150,12 +13053,13 @@ results in the list. + - ListProductsInProductSetRequest - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest + GcsDestination + \Google\Cloud\Vision\V1\GcsDestination - Request message for the `ListProductsInProductSet` method. - Generated from protobuf message <code>google.cloud.vision.v1.ListProductsInProductSetRequest</code> + The Google Cloud Storage location where the output will be written to. + Generated from protobuf message <code>google.cloud.vision.v1.GcsDestination</code> \Google\Protobuf\Internal\Message - - name - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::$name + + uri + \Google\Cloud\Vision\V1\GcsDestination::$uri '' - - Required. The ProductSet resource for which to retrieve Products. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - page_size - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::$page_size - 0 - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> - - - + + Google Cloud Storage URI prefix where the results will be stored. Results +will be in JSON format and preceded by its corresponding input URI prefix. + This field can either represent a gcs file prefix or gcs directory. In +either case, the uri should be unique because in order to get all of the +output files, you will need to do a wildcard gcs search on the uri prefix +you provide. +Examples: +* File Prefix: gs://bucket-name/here/filenameprefix The output files +will be created in gs://bucket-name/here/ and the names of the +output files will begin with "filenameprefix". +* Directory Prefix: gs://bucket-name/some/location/ The output files +will be created in gs://bucket-name/some/location/ and the names of the +output files could be anything because there was no filename prefix +specified. +If multiple outputs, each response is still AnnotateFileResponse, each of +which contains some subset of the full list of AnnotateImageResponse. +Multiple outputs can happen if, for example, the output JSON is too large +and overflows into multiple sharded files. - - page_token - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::$page_token - '' - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string page_token = 3;</code> +Generated from protobuf field <code>string uri = 1;</code> - - build - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::build() - - - name - - string - - - - - - - - - - - - - + __construct - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::__construct() + \Google\Cloud\Vision\V1\GcsDestination::__construct() - + data - NULL + null array - + Constructor. - - getName - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::getName() + + getUri + \Google\Cloud\Vision\V1\GcsDestination::getUri() - - Required. The ProductSet resource for which to retrieve Products. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + + Google Cloud Storage URI prefix where the results will be stored. Results +will be in JSON format and preceded by its corresponding input URI prefix. + This field can either represent a gcs file prefix or gcs directory. In +either case, the uri should be unique because in order to get all of the +output files, you will need to do a wildcard gcs search on the uri prefix +you provide. +Examples: +* File Prefix: gs://bucket-name/here/filenameprefix The output files +will be created in gs://bucket-name/here/ and the names of the +output files will begin with "filenameprefix". +* Directory Prefix: gs://bucket-name/some/location/ The output files +will be created in gs://bucket-name/some/location/ and the names of the +output files could be anything because there was no filename prefix +specified. +If multiple outputs, each response is still AnnotateFileResponse, each of +which contains some subset of the full list of AnnotateImageResponse. +Multiple outputs can happen if, for example, the output JSON is too large +and overflows into multiple sharded files. -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>string uri = 1;</code> - - setName - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::setName() + + setUri + \Google\Cloud\Vision\V1\GcsDestination::setUri() - + var string - - Required. The ProductSet resource for which to retrieve Products. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - - - getPageSize - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::getPageSize() - - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> - - - - - - - setPageSize - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::setPageSize() - - - var - - int - - - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> - - - - - - - - getPageToken - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::getPageToken() - - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string page_token = 3;</code> - - - - - - - setPageToken - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::setPageToken() - - - var - - string - + + Google Cloud Storage URI prefix where the results will be stored. Results +will be in JSON format and preceded by its corresponding input URI prefix. + This field can either represent a gcs file prefix or gcs directory. In +either case, the uri should be unique because in order to get all of the +output files, you will need to do a wildcard gcs search on the uri prefix +you provide. +Examples: +* File Prefix: gs://bucket-name/here/filenameprefix The output files +will be created in gs://bucket-name/here/ and the names of the +output files will begin with "filenameprefix". +* Directory Prefix: gs://bucket-name/some/location/ The output files +will be created in gs://bucket-name/some/location/ and the names of the +output files could be anything because there was no filename prefix +specified. +If multiple outputs, each response is still AnnotateFileResponse, each of +which contains some subset of the full list of AnnotateImageResponse. +Multiple outputs can happen if, for example, the output JSON is too large +and overflows into multiple sharded files. - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string page_token = 3;</code> +Generated from protobuf field <code>string uri = 1;</code> - + @@ -26402,12 +13220,13 @@ Generated from protobuf field <code>string name = 1 [(.google.api.field_be + - ListProductsInProductSetResponse - \Google\Cloud\Vision\V1\ListProductsInProductSetResponse + GcsSource + \Google\Cloud\Vision\V1\GcsSource - Response message for the `ListProductsInProductSet` method. - Generated from protobuf message <code>google.cloud.vision.v1.ListProductsInProductSetResponse</code> + The Google Cloud Storage location where the input will be read from. + Generated from protobuf message <code>google.cloud.vision.v1.GcsSource</code> \Google\Protobuf\Internal\Message - - products - \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::$products - - - The list of Products. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> - - - - - - next_page_token - \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::$next_page_token + + uri + \Google\Cloud\Vision\V1\GcsSource::$uri '' - - Token to retrieve the next page of results, or empty if there are no more -results in the list. - Generated from protobuf field <code>string next_page_token = 2;</code> + + Google Cloud Storage URI for the input file. This must only be a +Google Cloud Storage object. Wildcards are not currently supported. + Generated from protobuf field <code>string uri = 1;</code> - + __construct - \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::__construct() + \Google\Cloud\Vision\V1\GcsSource::__construct() - + data - NULL + null array - + Constructor. - - getProducts - \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::getProducts() - - - The list of Products. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> - - - - - - - setProducts - \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::setProducts() - - - var - - \Google\Cloud\Vision\V1\Product[]|\Google\Protobuf\Internal\RepeatedField - - - - The list of Products. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> - - - - - - - - getNextPageToken - \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::getNextPageToken() + + getUri + \Google\Cloud\Vision\V1\GcsSource::getUri() - - Token to retrieve the next page of results, or empty if there are no more -results in the list. - Generated from protobuf field <code>string next_page_token = 2;</code> + + Google Cloud Storage URI for the input file. This must only be a +Google Cloud Storage object. Wildcards are not currently supported. + Generated from protobuf field <code>string uri = 1;</code> - - setNextPageToken - \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::setNextPageToken() + + setUri + \Google\Cloud\Vision\V1\GcsSource::setUri() - + var string - - Token to retrieve the next page of results, or empty if there are no more -results in the list. - Generated from protobuf field <code>string next_page_token = 2;</code> + + Google Cloud Storage URI for the input file. This must only be a +Google Cloud Storage object. Wildcards are not currently supported. + Generated from protobuf field <code>string uri = 1;</code> - + @@ -26568,12 +13336,13 @@ results in the list. + - ListProductsRequest - \Google\Cloud\Vision\V1\ListProductsRequest + GetProductRequest + \Google\Cloud\Vision\V1\GetProductRequest - Request message for the `ListProducts` method. - Generated from protobuf message <code>google.cloud.vision.v1.ListProductsRequest</code> + Request message for the `GetProduct` method. + Generated from protobuf message <code>google.cloud.vision.v1.GetProductRequest</code> \Google\Protobuf\Internal\Message - - parent - \Google\Cloud\Vision\V1\ListProductsRequest::$parent + + name + \Google\Cloud\Vision\V1\GetProductRequest::$name '' - Required. The project OR ProductSet from which Products should be listed. - Format: -`projects/PROJECT_ID/locations/LOC_ID` - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - - - - page_size - \Google\Cloud\Vision\V1\ListProductsRequest::$page_size - 0 - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> - - - + Required. Resource name of the Product to get. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - - page_token - \Google\Cloud\Vision\V1\ListProductsRequest::$page_token - '' - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string page_token = 3;</code> +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - + build - \Google\Cloud\Vision\V1\ListProductsRequest::build() + \Google\Cloud\Vision\V1\GetProductRequest::build() - - parent + + name string - + + description="Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` Please see {@see \Google\Cloud\Vision\V1\ProductSearchClient::productName()} for help formatting this field." + variable="name" type="string"/> + type="\Google\Cloud\Vision\V1\GetProductRequest"/> - + __construct - \Google\Cloud\Vision\V1\ListProductsRequest::__construct() + \Google\Cloud\Vision\V1\GetProductRequest::__construct() - + data - NULL + null array - + Constructor. - - getParent - \Google\Cloud\Vision\V1\ListProductsRequest::getParent() + + getName + \Google\Cloud\Vision\V1\GetProductRequest::getName() - - Required. The project OR ProductSet from which Products should be listed. - Format: -`projects/PROJECT_ID/locations/LOC_ID` + + Required. Resource name of the Product to get. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + + setName + \Google\Cloud\Vision\V1\GetProductRequest::setName() + + + var + + string + + + + Required. Resource name of the Product to get. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + GetProductSetRequest + \Google\Cloud\Vision\V1\GetProductSetRequest + + Request message for the `GetProductSet` method. + Generated from protobuf message <code>google.cloud.vision.v1.GetProductSetRequest</code> + name="package" + description="Application" + /> - + \Google\Protobuf\Internal\Message + + + + name + \Google\Cloud\Vision\V1\GetProductSetRequest::$name + '' + + Required. Resource name of the ProductSet to get. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - - setParent - \Google\Cloud\Vision\V1\ListProductsRequest::setParent() +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + + build + \Google\Cloud\Vision\V1\GetProductSetRequest::build() - - var + + name string - - Required. The project OR ProductSet from which Products should be listed. - Format: -`projects/PROJECT_ID/locations/LOC_ID` - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + description="Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` Please see {@see \Google\Cloud\Vision\V1\ProductSearchClient::productSetName()} for help formatting this field." + variable="name" type="string"/> - - - - - - getPageSize - \Google\Cloud\Vision\V1\ListProductsRequest::getPageSize() - - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> - + + /> - - setPageSize - \Google\Cloud\Vision\V1\ListProductsRequest::setPageSize() + + __construct + \Google\Cloud\Vision\V1\GetProductSetRequest::__construct() - - var - - int + + data + null + array - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type string $name Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` }" + variable="data" type="array"/> - - getPageToken - \Google\Cloud\Vision\V1\ListProductsRequest::getPageToken() + + getName + \Google\Cloud\Vision\V1\GetProductSetRequest::getName() - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string page_token = 3;</code> + + Required. Resource name of the ProductSet to get. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - setPageToken - \Google\Cloud\Vision\V1\ListProductsRequest::setPageToken() + + setName + \Google\Cloud\Vision\V1\GetProductSetRequest::setName() - + var string - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string page_token = 3;</code> + + Required. Resource name of the ProductSet to get. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - + @@ -26820,12 +13638,13 @@ Generated from protobuf field <code>string parent = 1 [(.google.api.field_ + - ListProductsResponse - \Google\Cloud\Vision\V1\ListProductsResponse + GetReferenceImageRequest + \Google\Cloud\Vision\V1\GetReferenceImageRequest - Response message for the `ListProducts` method. - Generated from protobuf message <code>google.cloud.vision.v1.ListProductsResponse</code> + Request message for the `GetReferenceImage` method. + Generated from protobuf message <code>google.cloud.vision.v1.GetReferenceImageRequest</code> \Google\Protobuf\Internal\Message - - products - \Google\Cloud\Vision\V1\ListProductsResponse::$products - - - List of products. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> - - - - - - next_page_token - \Google\Cloud\Vision\V1\ListProductsResponse::$next_page_token + + name + \Google\Cloud\Vision\V1\GetReferenceImageRequest::$name '' - - Token to retrieve the next page of results, or empty if there are no more -results in the list. - Generated from protobuf field <code>string next_page_token = 2;</code> + + Required. The resource name of the ReferenceImage to get. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - __construct - \Google\Cloud\Vision\V1\ListProductsResponse::__construct() + + build + \Google\Cloud\Vision\V1\GetReferenceImageRequest::build() - - data - NULL - array + + name + + string - - Constructor. + + - - - - - - getProducts - \Google\Cloud\Vision\V1\ListProductsResponse::getProducts() - - - List of products. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> - + + type="\Google\Cloud\Vision\V1\GetReferenceImageRequest"/> + - - setProducts - \Google\Cloud\Vision\V1\ListProductsResponse::setProducts() + + __construct + \Google\Cloud\Vision\V1\GetReferenceImageRequest::__construct() - - var - - \Google\Cloud\Vision\V1\Product[]|\Google\Protobuf\Internal\RepeatedField + + data + null + array - - List of products. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type string $name Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. }" + variable="data" type="array"/> - - getNextPageToken - \Google\Cloud\Vision\V1\ListProductsResponse::getNextPageToken() + + getName + \Google\Cloud\Vision\V1\GetReferenceImageRequest::getName() - - Token to retrieve the next page of results, or empty if there are no more -results in the list. - Generated from protobuf field <code>string next_page_token = 2;</code> + + Required. The resource name of the ReferenceImage to get. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - setNextPageToken - \Google\Cloud\Vision\V1\ListProductsResponse::setNextPageToken() + + setName + \Google\Cloud\Vision\V1\GetReferenceImageRequest::setName() - + var string - - Token to retrieve the next page of results, or empty if there are no more -results in the list. - Generated from protobuf field <code>string next_page_token = 2;</code> + + Required. The resource name of the ReferenceImage to get. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - + @@ -26986,12 +13789,13 @@ results in the list. + - ListReferenceImagesRequest - \Google\Cloud\Vision\V1\ListReferenceImagesRequest + Image + \Google\Cloud\Vision\V1\Image - Request message for the `ListReferenceImages` method. - Generated from protobuf message <code>google.cloud.vision.v1.ListReferenceImagesRequest</code> + Client image to perform Google Cloud Vision API tasks over. + Generated from protobuf message <code>google.cloud.vision.v1.Image</code> \Google\Protobuf\Internal\Message - - parent - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::$parent + + content + \Google\Cloud\Vision\V1\Image::$content '' - - Required. Resource name of the product containing the reference images. - Format is -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - - + + Image content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary +representation, whereas JSON representations use base64. +Currently, this field only works for BatchAnnotateImages requests. It does +not work for AsyncBatchAnnotateImages requests. - - page_size - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::$page_size - 0 - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> +Generated from protobuf field <code>bytes content = 1;</code> - - page_token - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::$page_token - '' - - A token identifying a page of results to be returned. This is the value -of `nextPageToken` returned in a previous reference image list request. - Defaults to the first page if not specified. - -Generated from protobuf field <code>string page_token = 3;</code> + + source + \Google\Cloud\Vision\V1\Image::$source + null + + Google Cloud Storage image location, or publicly-accessible image +URL. If both `content` and `source` are provided for an image, `content` +takes precedence and is used to perform the image annotation request. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageSource source = 2;</code> - - build - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::build() - - - parent - - string - - - - - - - - - - - - - + __construct - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::__construct() + \Google\Cloud\Vision\V1\Image::__construct() - + data - NULL + null array - + Constructor. - - getParent - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::getParent() + + getContent + \Google\Cloud\Vision\V1\Image::getContent() - - Required. Resource name of the product containing the reference images. - Format is -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + + Image content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary +representation, whereas JSON representations use base64. +Currently, this field only works for BatchAnnotateImages requests. It does +not work for AsyncBatchAnnotateImages requests. -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>bytes content = 1;</code> - - setParent - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::setParent() + + setContent + \Google\Cloud\Vision\V1\Image::setContent() - + var string - - Required. Resource name of the product containing the reference images. - Format is -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + + Image content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary +representation, whereas JSON representations use base64. +Currently, this field only works for BatchAnnotateImages requests. It does +not work for AsyncBatchAnnotateImages requests. -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>bytes content = 1;</code> - - getPageSize - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::getPageSize() + + getSource + \Google\Cloud\Vision\V1\Image::getSource() - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> + + Google Cloud Storage image location, or publicly-accessible image +URL. If both `content` and `source` are provided for an image, `content` +takes precedence and is used to perform the image annotation request. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageSource source = 2;</code> + type="\Google\Cloud\Vision\V1\ImageSource|null"/> - - setPageSize - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::setPageSize() + + hasSource + \Google\Cloud\Vision\V1\Image::hasSource() - - var - - int - - - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> - - - + + + + - - getPageToken - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::getPageToken() + + clearSource + \Google\Cloud\Vision\V1\Image::clearSource() - - A token identifying a page of results to be returned. This is the value -of `nextPageToken` returned in a previous reference image list request. - Defaults to the first page if not specified. - -Generated from protobuf field <code>string page_token = 3;</code> - - + + + + - - setPageToken - \Google\Cloud\Vision\V1\ListReferenceImagesRequest::setPageToken() + + setSource + \Google\Cloud\Vision\V1\Image::setSource() - + var - string + \Google\Cloud\Vision\V1\ImageSource - - A token identifying a page of results to be returned. This is the value -of `nextPageToken` returned in a previous reference image list request. - Defaults to the first page if not specified. - -Generated from protobuf field <code>string page_token = 3;</code> + + Google Cloud Storage image location, or publicly-accessible image +URL. If both `content` and `source` are provided for an image, `content` +takes precedence and is used to perform the image annotation request. + Generated from protobuf field <code>.google.cloud.vision.v1.ImageSource source = 2;</code> + variable="var" type="\Google\Cloud\Vision\V1\ImageSource"/> - + @@ -27247,12 +13996,14 @@ Generated from protobuf field <code>string page_token = 3;</code> - ListReferenceImagesResponse - \Google\Cloud\Vision\V1\ListReferenceImagesResponse - - Response message for the `ListReferenceImages` method. - Generated from protobuf message <code>google.cloud.vision.v1.ListReferenceImagesResponse</code> + + + ImageAnnotationContext + \Google\Cloud\Vision\V1\ImageAnnotationContext + + If an image was produced from a file (e.g. a PDF), this message gives +information about the source of that image. + Generated from protobuf message <code>google.cloud.vision.v1.ImageAnnotationContext</code> \Google\Protobuf\Internal\Message - - reference_images - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::$reference_images - - - The list of reference images. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> - - - - - - page_size - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::$page_size - 0 - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> + + uri + \Google\Cloud\Vision\V1\ImageAnnotationContext::$uri + '' + + The URI of the file used to produce the image. + Generated from protobuf field <code>string uri = 1;</code> - - next_page_token - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::$next_page_token - '' - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string next_page_token = 3;</code> + + page_number + \Google\Cloud\Vision\V1\ImageAnnotationContext::$page_number + 0 + + If the file was a PDF or TIFF, this field gives the page number within +the file used to produce the image. + Generated from protobuf field <code>int32 page_number = 2;</code> - + __construct - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::__construct() + \Google\Cloud\Vision\V1\ImageAnnotationContext::__construct() - + data - NULL + null array - + Constructor. - - getReferenceImages - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::getReferenceImages() + + getUri + \Google\Cloud\Vision\V1\ImageAnnotationContext::getUri() - - The list of reference images. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> + + The URI of the file used to produce the image. + Generated from protobuf field <code>string uri = 1;</code> + type="string"/> - - setReferenceImages - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::setReferenceImages() + + setUri + \Google\Cloud\Vision\V1\ImageAnnotationContext::setUri() - + var - \Google\Cloud\Vision\V1\ReferenceImage[]|\Google\Protobuf\Internal\RepeatedField + string - - The list of reference images. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> + + The URI of the file used to produce the image. + Generated from protobuf field <code>string uri = 1;</code> + variable="var" type="string"/> - - getPageSize - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::getPageSize() + + getPageNumber + \Google\Cloud\Vision\V1\ImageAnnotationContext::getPageNumber() - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> + + If the file was a PDF or TIFF, this field gives the page number within +the file used to produce the image. + Generated from protobuf field <code>int32 page_number = 2;</code> - - setPageSize - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::setPageSize() + + setPageNumber + \Google\Cloud\Vision\V1\ImageAnnotationContext::setPageNumber() - + var int - - The maximum number of items to return. Default 10, maximum 100. - Generated from protobuf field <code>int32 page_size = 2;</code> + + If the file was a PDF or TIFF, this field gives the page number within +the file used to produce the image. + Generated from protobuf field <code>int32 page_number = 2;</code> - - - - getNextPageToken - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::getNextPageToken() - - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string next_page_token = 3;</code> - - - - - - - setNextPageToken - \Google\Cloud\Vision\V1\ListReferenceImagesResponse::setNextPageToken() - - - var - - string - - - - The next_page_token returned from a previous List request, if any. - Generated from protobuf field <code>string next_page_token = 3;</code> - - - - @@ -27443,7 +14146,7 @@ Generated from protobuf field <code>string page_token = 3;</code> - + @@ -27461,12 +14164,13 @@ Generated from protobuf field <code>string page_token = 3;</code> - LocalizedObjectAnnotation - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation + ImageContext + \Google\Cloud\Vision\V1\ImageContext - Set of detected objects with bounding boxes. - Generated from protobuf message <code>google.cloud.vision.v1.LocalizedObjectAnnotation</code> + Image context and/or feature-specific parameters. + Generated from protobuf message <code>google.cloud.vision.v1.ImageContext</code> \Google\Protobuf\Internal\Message - - mid - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$mid - '' + + lat_long_rect + \Google\Cloud\Vision\V1\ImageContext::$lat_long_rect + null - Object ID that should align with EntityAnnotation mid. - Generated from protobuf field <code>string mid = 1;</code> + Not used. + Generated from protobuf field <code>.google.cloud.vision.v1.LatLongRect lat_long_rect = 1;</code> - - language_code - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$language_code - '' - - The BCP-47 language code, such as "en-US" or "sr-Latn". For more -information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - Generated from protobuf field <code>string language_code = 2;</code> + + language_hints + \Google\Cloud\Vision\V1\ImageContext::$language_hints + + + List of languages to use for TEXT_DETECTION. In most cases, an empty value +yields the best results since it enables automatic language detection. For +languages based on the Latin alphabet, setting `language_hints` is not +needed. In rare cases, when the language of the text in the image is known, +setting a hint will help get better results (although it will be a +significant hindrance if the hint is wrong). Text detection returns an +error if one or more of the specified languages is not one of the +[supported languages](https://cloud.google.com/vision/docs/languages). + Generated from protobuf field <code>repeated string language_hints = 2;</code> - - name - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$name - '' - - Object name, expressed in its `language_code` language. - Generated from protobuf field <code>string name = 3;</code> + + crop_hints_params + \Google\Cloud\Vision\V1\ImageContext::$crop_hints_params + null + + Parameters for crop hints annotation request. + Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsParams crop_hints_params = 4;</code> - - score - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$score - 0.0 - - Score of the result. Range [0, 1]. - Generated from protobuf field <code>float score = 4;</code> + + product_search_params + \Google\Cloud\Vision\V1\ImageContext::$product_search_params + null + + Parameters for product search. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchParams product_search_params = 5;</code> - - bounding_poly - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$bounding_poly + + web_detection_params + \Google\Cloud\Vision\V1\ImageContext::$web_detection_params null - - Image region to which this object belongs. This must be populated. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 5;</code> + + Parameters for web detection. + Generated from protobuf field <code>.google.cloud.vision.v1.WebDetectionParams web_detection_params = 6;</code> + + + + + + text_detection_params + \Google\Cloud\Vision\V1\ImageContext::$text_detection_params + null + + Parameters for text detection and document text detection. + Generated from protobuf field <code>.google.cloud.vision.v1.TextDetectionParams text_detection_params = 12;</code> - + __construct - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::__construct() + \Google\Cloud\Vision\V1\ImageContext::__construct() - + data - NULL + null array - + Constructor. - - - - - - getMid - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getMid() - - - Object ID that should align with EntityAnnotation mid. - Generated from protobuf field <code>string mid = 1;</code> - - - - - - - setMid - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setMid() - - - var - - string - - - - Object ID that should align with EntityAnnotation mid. - Generated from protobuf field <code>string mid = 1;</code> - - + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\LatLongRect $lat_long_rect Not used. @type string[] $language_hints List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages). @type \Google\Cloud\Vision\V1\CropHintsParams $crop_hints_params Parameters for crop hints annotation request. @type \Google\Cloud\Vision\V1\ProductSearchParams $product_search_params Parameters for product search. @type \Google\Cloud\Vision\V1\WebDetectionParams $web_detection_params Parameters for web detection. @type \Google\Cloud\Vision\V1\TextDetectionParams $text_detection_params Parameters for text detection and document text detection. }" + variable="data" type="array"/> - - getLanguageCode - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getLanguageCode() + + getLatLongRect + \Google\Cloud\Vision\V1\ImageContext::getLatLongRect() - - The BCP-47 language code, such as "en-US" or "sr-Latn". For more -information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - Generated from protobuf field <code>string language_code = 2;</code> + + Not used. + Generated from protobuf field <code>.google.cloud.vision.v1.LatLongRect lat_long_rect = 1;</code> + type="\Google\Cloud\Vision\V1\LatLongRect|null"/> - - setLanguageCode - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setLanguageCode() + + hasLatLongRect + \Google\Cloud\Vision\V1\ImageContext::hasLatLongRect() - - var - - string - - - - The BCP-47 language code, such as "en-US" or "sr-Latn". For more -information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - Generated from protobuf field <code>string language_code = 2;</code> - - - + + + + - - getName - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getName() + + clearLatLongRect + \Google\Cloud\Vision\V1\ImageContext::clearLatLongRect() - - Object name, expressed in its `language_code` language. - Generated from protobuf field <code>string name = 3;</code> - - + + + + - - setName - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setName() + + setLatLongRect + \Google\Cloud\Vision\V1\ImageContext::setLatLongRect() - + var - string + \Google\Cloud\Vision\V1\LatLongRect - - Object name, expressed in its `language_code` language. - Generated from protobuf field <code>string name = 3;</code> + + Not used. + Generated from protobuf field <code>.google.cloud.vision.v1.LatLongRect lat_long_rect = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\LatLongRect"/> - - getScore - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getScore() + + getLanguageHints + \Google\Cloud\Vision\V1\ImageContext::getLanguageHints() - - Score of the result. Range [0, 1]. - Generated from protobuf field <code>float score = 4;</code> + + List of languages to use for TEXT_DETECTION. In most cases, an empty value +yields the best results since it enables automatic language detection. For +languages based on the Latin alphabet, setting `language_hints` is not +needed. In rare cases, when the language of the text in the image is known, +setting a hint will help get better results (although it will be a +significant hindrance if the hint is wrong). Text detection returns an +error if one or more of the specified languages is not one of the +[supported languages](https://cloud.google.com/vision/docs/languages). + Generated from protobuf field <code>repeated string language_hints = 2;</code> + type="\Google\Protobuf\RepeatedField<string>"/> - - setScore - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setScore() + + setLanguageHints + \Google\Cloud\Vision\V1\ImageContext::setLanguageHints() - + var - float + string[] - - Score of the result. Range [0, 1]. - Generated from protobuf field <code>float score = 4;</code> + + List of languages to use for TEXT_DETECTION. In most cases, an empty value +yields the best results since it enables automatic language detection. For +languages based on the Latin alphabet, setting `language_hints` is not +needed. In rare cases, when the language of the text in the image is known, +setting a hint will help get better results (although it will be a +significant hindrance if the hint is wrong). Text detection returns an +error if one or more of the specified languages is not one of the +[supported languages](https://cloud.google.com/vision/docs/languages). + Generated from protobuf field <code>repeated string language_hints = 2;</code> + variable="var" type="string[]"/> - - getBoundingPoly - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getBoundingPoly() + + getCropHintsParams + \Google\Cloud\Vision\V1\ImageContext::getCropHintsParams() - - Image region to which this object belongs. This must be populated. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 5;</code> + + Parameters for crop hints annotation request. + Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsParams crop_hints_params = 4;</code> + type="\Google\Cloud\Vision\V1\CropHintsParams|null"/> - - hasBoundingPoly - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::hasBoundingPoly() + + hasCropHintsParams + \Google\Cloud\Vision\V1\ImageContext::hasCropHintsParams() - + - - clearBoundingPoly - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::clearBoundingPoly() + + clearCropHintsParams + \Google\Cloud\Vision\V1\ImageContext::clearCropHintsParams() - + - - setBoundingPoly - \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setBoundingPoly() + + setCropHintsParams + \Google\Cloud\Vision\V1\ImageContext::setCropHintsParams() - + var - \Google\Cloud\Vision\V1\BoundingPoly + \Google\Cloud\Vision\V1\CropHintsParams - - Image region to which this object belongs. This must be populated. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 5;</code> + + Parameters for crop hints annotation request. + Generated from protobuf field <code>.google.cloud.vision.v1.CropHintsParams crop_hints_params = 4;</code> + variable="var" type="\Google\Cloud\Vision\V1\CropHintsParams"/> - - - - - - - - - - - - - - - - - - - - - - - LocationInfo - \Google\Cloud\Vision\V1\LocationInfo - - Detected entity location information. - Generated from protobuf message <code>google.cloud.vision.v1.LocationInfo</code> - - - - \Google\Protobuf\Internal\Message - - - - lat_lng - \Google\Cloud\Vision\V1\LocationInfo::$lat_lng - null - - lat/long location coordinates. - Generated from protobuf field <code>.google.type.LatLng lat_lng = 1;</code> - - - - - - - __construct - \Google\Cloud\Vision\V1\LocationInfo::__construct() - - - data - NULL - array - - - - Constructor. - - - - - - - - getLatLng - \Google\Cloud\Vision\V1\LocationInfo::getLatLng() + + getProductSearchParams + \Google\Cloud\Vision\V1\ImageContext::getProductSearchParams() - - lat/long location coordinates. - Generated from protobuf field <code>.google.type.LatLng lat_lng = 1;</code> + + Parameters for product search. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchParams product_search_params = 5;</code> + type="\Google\Cloud\Vision\V1\ProductSearchParams|null"/> - - hasLatLng - \Google\Cloud\Vision\V1\LocationInfo::hasLatLng() + + hasProductSearchParams + \Google\Cloud\Vision\V1\ImageContext::hasProductSearchParams() - + - - clearLatLng - \Google\Cloud\Vision\V1\LocationInfo::clearLatLng() + + clearProductSearchParams + \Google\Cloud\Vision\V1\ImageContext::clearProductSearchParams() - + - - setLatLng - \Google\Cloud\Vision\V1\LocationInfo::setLatLng() + + setProductSearchParams + \Google\Cloud\Vision\V1\ImageContext::setProductSearchParams() - + var - \Google\Type\LatLng + \Google\Cloud\Vision\V1\ProductSearchParams - - lat/long location coordinates. - Generated from protobuf field <code>.google.type.LatLng lat_lng = 1;</code> + + Parameters for product search. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSearchParams product_search_params = 5;</code> + variable="var" type="\Google\Cloud\Vision\V1\ProductSearchParams"/> - - - - - - - - - - - - - - - - - - - - - - - NormalizedVertex - \Google\Cloud\Vision\V1\NormalizedVertex - - A vertex represents a 2D point in the image. - NOTE: the normalized vertex coordinates are relative to the original image -and range from 0 to 1. - -Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVertex</code> + + getWebDetectionParams + \Google\Cloud\Vision\V1\ImageContext::getWebDetectionParams() + + + Parameters for web detection. + Generated from protobuf field <code>.google.cloud.vision.v1.WebDetectionParams web_detection_params = 6;</code> + name="return" + description="" + type="\Google\Cloud\Vision\V1\WebDetectionParams|null"/> - \Google\Protobuf\Internal\Message - - - - x - \Google\Cloud\Vision\V1\NormalizedVertex::$x - 0.0 - - X coordinate. - Generated from protobuf field <code>float x = 1;</code> - - - - - - y - \Google\Cloud\Vision\V1\NormalizedVertex::$y - 0.0 - - Y coordinate. - Generated from protobuf field <code>float y = 2;</code> - - - + - - - __construct - \Google\Cloud\Vision\V1\NormalizedVertex::__construct() + + hasWebDetectionParams + \Google\Cloud\Vision\V1\ImageContext::hasWebDetectionParams() - - data - NULL - array - - - - Constructor. + + - - + - - getX - \Google\Cloud\Vision\V1\NormalizedVertex::getX() + + clearWebDetectionParams + \Google\Cloud\Vision\V1\ImageContext::clearWebDetectionParams() - - X coordinate. - Generated from protobuf field <code>float x = 1;</code> - - + + + + - - setX - \Google\Cloud\Vision\V1\NormalizedVertex::setX() + + setWebDetectionParams + \Google\Cloud\Vision\V1\ImageContext::setWebDetectionParams() - + var - float + \Google\Cloud\Vision\V1\WebDetectionParams - - X coordinate. - Generated from protobuf field <code>float x = 1;</code> + + Parameters for web detection. + Generated from protobuf field <code>.google.cloud.vision.v1.WebDetectionParams web_detection_params = 6;</code> + variable="var" type="\Google\Cloud\Vision\V1\WebDetectionParams"/> - - getY - \Google\Cloud\Vision\V1\NormalizedVertex::getY() + + getTextDetectionParams + \Google\Cloud\Vision\V1\ImageContext::getTextDetectionParams() - - Y coordinate. - Generated from protobuf field <code>float y = 2;</code> + + Parameters for text detection and document text detection. + Generated from protobuf field <code>.google.cloud.vision.v1.TextDetectionParams text_detection_params = 12;</code> + type="\Google\Cloud\Vision\V1\TextDetectionParams|null"/> - - setY - \Google\Cloud\Vision\V1\NormalizedVertex::setY() + + hasTextDetectionParams + \Google\Cloud\Vision\V1\ImageContext::hasTextDetectionParams() - + + + + + + + + + clearTextDetectionParams + \Google\Cloud\Vision\V1\ImageContext::clearTextDetectionParams() + + + + + + + + + + setTextDetectionParams + \Google\Cloud\Vision\V1\ImageContext::setTextDetectionParams() + + var - float + \Google\Cloud\Vision\V1\TextDetectionParams - - Y coordinate. - Generated from protobuf field <code>float y = 2;</code> + + Parameters for text detection and document text detection. + Generated from protobuf field <code>.google.cloud.vision.v1.TextDetectionParams text_detection_params = 12;</code> + variable="var" type="\Google\Cloud\Vision\V1\TextDetectionParams"/> - + @@ -28099,125 +14657,120 @@ Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVer - + - - State - \Google\Cloud\Vision\V1\OperationMetadata\State - - Batch operation states. - Protobuf type <code>google.cloud.vision.v1.OperationMetadata.State</code> + + + ImageProperties + \Google\Cloud\Vision\V1\ImageProperties + + Stores image properties, such as dominant colors. + Generated from protobuf message <code>google.cloud.vision.v1.ImageProperties</code> + \Google\Protobuf\Internal\Message - - - STATE_UNSPECIFIED - \Google\Cloud\Vision\V1\OperationMetadata\State::STATE_UNSPECIFIED - 0 - - Invalid. - Generated from protobuf enum <code>STATE_UNSPECIFIED = 0;</code> - - - - - - CREATED - \Google\Cloud\Vision\V1\OperationMetadata\State::CREATED - 1 - - Request is received. - Generated from protobuf enum <code>CREATED = 1;</code> - - - + + + dominant_colors + \Google\Cloud\Vision\V1\ImageProperties::$dominant_colors + null + + If present, dominant colors completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.DominantColorsAnnotation dominant_colors = 1;</code> + - - RUNNING - \Google\Cloud\Vision\V1\OperationMetadata\State::RUNNING - 2 - - Request is actively being processed. - Generated from protobuf enum <code>RUNNING = 2;</code> - + - + + + __construct + \Google\Cloud\Vision\V1\ImageProperties::__construct() + + + data + null + array + - - DONE - \Google\Cloud\Vision\V1\OperationMetadata\State::DONE - 3 - - The batch processing is done. - Generated from protobuf enum <code>DONE = 3;</code> - + + Constructor. + + + - + - - CANCELLED - \Google\Cloud\Vision\V1\OperationMetadata\State::CANCELLED - 4 - - The batch processing was cancelled. - Generated from protobuf enum <code>CANCELLED = 4;</code> - + + getDominantColors + \Google\Cloud\Vision\V1\ImageProperties::getDominantColors() + + + If present, dominant colors completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.DominantColorsAnnotation dominant_colors = 1;</code> + + - + - - - valueToName - \Google\Cloud\Vision\V1\OperationMetadata\State::$valueToName - [self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', self::CREATED => 'CREATED', self::RUNNING => 'RUNNING', self::DONE => 'DONE', self::CANCELLED => 'CANCELLED'] - + + hasDominantColors + \Google\Cloud\Vision\V1\ImageProperties::hasDominantColors() + + - + - + - - - name - \Google\Cloud\Vision\V1\OperationMetadata\State::name() + + clearDominantColors + \Google\Cloud\Vision\V1\ImageProperties::clearDominantColors() - - value - - mixed - - - + - + - - value - \Google\Cloud\Vision\V1\OperationMetadata\State::value() + + setDominantColors + \Google\Cloud\Vision\V1\ImageProperties::setDominantColors() - - name + + var - mixed + \Google\Cloud\Vision\V1\DominantColorsAnnotation - - - - + + If present, dominant colors completed successfully. + Generated from protobuf field <code>.google.cloud.vision.v1.DominantColorsAnnotation dominant_colors = 1;</code> + + + @@ -28227,7 +14780,7 @@ Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVer - + @@ -28245,12 +14798,13 @@ Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVer + - OperationMetadata - \Google\Cloud\Vision\V1\OperationMetadata + ImageSource + \Google\Cloud\Vision\V1\ImageSource - Contains metadata for the BatchAnnotateImages operation. - Generated from protobuf message <code>google.cloud.vision.v1.OperationMetadata</code> + External image source (Google Cloud Storage or web URL image location). + Generated from protobuf message <code>google.cloud.vision.v1.ImageSource</code> \Google\Protobuf\Internal\Message - - state - \Google\Cloud\Vision\V1\OperationMetadata::$state - 0 - - Current state of the batch operation. - Generated from protobuf field <code>.google.cloud.vision.v1.OperationMetadata.State state = 1;</code> + + gcs_image_uri + \Google\Cloud\Vision\V1\ImageSource::$gcs_image_uri + '' + + **Use `image_uri` instead.** +The Google Cloud Storage URI of the form +`gs://bucket_name/object_name`. Object versioning is not supported. See +[Google Cloud Storage Request +URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + Generated from protobuf field <code>string gcs_image_uri = 1;</code> - - create_time - \Google\Cloud\Vision\V1\OperationMetadata::$create_time - null - - The time when the batch request was received. - Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 5;</code> - - - + + image_uri + \Google\Cloud\Vision\V1\ImageSource::$image_uri + '' + + The URI of the source image. Can be either: +1. A Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. See + [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris) for more + info. + 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from + HTTP/HTTPS URLs, Google cannot guarantee that the request will be + completed. Your request may fail if the specified host denies the + request (e.g. due to request throttling or DOS prevention), or if Google + throttles requests to the site for abuse prevention. You should not + depend on externally-hosted images for production applications. +When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes +precedence. - - update_time - \Google\Cloud\Vision\V1\OperationMetadata::$update_time - null - - The time when the operation result was last updated. - Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 6;</code> +Generated from protobuf field <code>string image_uri = 2;</code> - + __construct - \Google\Cloud\Vision\V1\OperationMetadata::__construct() + \Google\Cloud\Vision\V1\ImageSource::__construct() - + data - NULL + null array - + Constructor. - - getState - \Google\Cloud\Vision\V1\OperationMetadata::getState() - - - Current state of the batch operation. - Generated from protobuf field <code>.google.cloud.vision.v1.OperationMetadata.State state = 1;</code> + + getGcsImageUri + \Google\Cloud\Vision\V1\ImageSource::getGcsImageUri() + + + **Use `image_uri` instead.** +The Google Cloud Storage URI of the form +`gs://bucket_name/object_name`. Object versioning is not supported. See +[Google Cloud Storage Request +URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + Generated from protobuf field <code>string gcs_image_uri = 1;</code> + + + + + + + setGcsImageUri + \Google\Cloud\Vision\V1\ImageSource::setGcsImageUri() + + + var + + string + + + + **Use `image_uri` instead.** +The Google Cloud Storage URI of the form +`gs://bucket_name/object_name`. Object versioning is not supported. See +[Google Cloud Storage Request +URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + Generated from protobuf field <code>string gcs_image_uri = 1;</code> + + + + + + + + getImageUri + \Google\Cloud\Vision\V1\ImageSource::getImageUri() + + + The URI of the source image. Can be either: +1. A Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. See + [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris) for more + info. + 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from + HTTP/HTTPS URLs, Google cannot guarantee that the request will be + completed. Your request may fail if the specified host denies the + request (e.g. due to request throttling or DOS prevention), or if Google + throttles requests to the site for abuse prevention. You should not + depend on externally-hosted images for production applications. +When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes +precedence. + +Generated from protobuf field <code>string image_uri = 2;</code> + type="string"/> - - setState - \Google\Cloud\Vision\V1\OperationMetadata::setState() + + setImageUri + \Google\Cloud\Vision\V1\ImageSource::setImageUri() - + var - int + string - - Current state of the batch operation. - Generated from protobuf field <code>.google.cloud.vision.v1.OperationMetadata.State state = 1;</code> + + The URI of the source image. Can be either: +1. A Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. See + [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris) for more + info. + 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from + HTTP/HTTPS URLs, Google cannot guarantee that the request will be + completed. Your request may fail if the specified host denies the + request (e.g. due to request throttling or DOS prevention), or if Google + throttles requests to the site for abuse prevention. You should not + depend on externally-hosted images for production applications. +When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes +precedence. + +Generated from protobuf field <code>string image_uri = 2;</code> + variable="var" type="string"/> - - getCreateTime - \Google\Cloud\Vision\V1\OperationMetadata::getCreateTime() - - - The time when the batch request was received. - Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 5;</code> + + + + + + + + + + - + name="package" + description="Application" + /> + - - - hasCreateTime - \Google\Cloud\Vision\V1\OperationMetadata::hasCreateTime() - - - - - + + + - + + + + + + ImportProductSetsGcsSource + \Google\Cloud\Vision\V1\ImportProductSetsGcsSource + + The Google Cloud Storage location for a csv file which preserves a list of +ImportProductSetRequests in each line. + Generated from protobuf message <code>google.cloud.vision.v1.ImportProductSetsGcsSource</code> + + - - clearCreateTime - \Google\Cloud\Vision\V1\OperationMetadata::clearCreateTime() - - - - - + \Google\Protobuf\Internal\Message + + + + csv_file_uri + \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::$csv_file_uri + '' + + The Google Cloud Storage URI of the input csv file. + The URI must start with `gs://`. +The format of the input csv file should be one image per line. +In each line, there are 8 columns. +1. image-uri +2. image-id +3. product-set-id +4. product-id +5. product-category +6. product-display-name +7. labels +8. bounding-poly +The `image-uri`, `product-set-id`, `product-id`, and `product-category` +columns are required. All other columns are optional. +If the `ProductSet` or `Product` specified by the `product-set-id` and +`product-id` values does not exist, then the system will create a new +`ProductSet` or `Product` for the image. In this case, the +`product-display-name` column refers to +[display_name][google.cloud.vision.v1.Product.display_name], the +`product-category` column refers to +[product_category][google.cloud.vision.v1.Product.product_category], and +the `labels` column refers to +[product_labels][google.cloud.vision.v1.Product.product_labels]. +The `image-id` column is optional but must be unique if provided. If it is +empty, the system will automatically assign a unique id to the image. +The `product-display-name` column is optional. If it is empty, the system +sets the [display_name][google.cloud.vision.v1.Product.display_name] field +for the product to a space (" "). You can update the `display_name` later +by using the API. +If a `Product` with the specified `product-id` already exists, then the +system ignores the `product-display-name`, `product-category`, and `labels` +columns. +The `labels` column (optional) is a line containing a list of +comma-separated key-value pairs, in the following format: + "key_1=value_1,key_2=value_2,...,key_n=value_n" +The `bounding-poly` column (optional) identifies one region of +interest from the image in the same manner as `CreateReferenceImage`. If +you do not specify the `bounding-poly` column, then the system will try to +detect regions of interest automatically. +At most one `bounding-poly` column is allowed per line. If the image +contains multiple regions of interest, add a line to the CSV file that +includes the same product information, and the `bounding-poly` values for +each region of interest. +The `bounding-poly` column must contain an even number of comma-separated +numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use +non-negative integers for absolute bounding polygons, and float values +in [0, 1] for normalized bounding polygons. +The system will resize the image if the image resolution is too +large to process (larger than 20MP). - +Generated from protobuf field <code>string csv_file_uri = 1;</code> + - - setCreateTime - \Google\Cloud\Vision\V1\OperationMetadata::setCreateTime() + + + + + __construct + \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::__construct() - - var - - \Google\Protobuf\Timestamp + + data + null + array - - The time when the batch request was received. - Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 5;</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type string $csv_file_uri The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. product-set-id 4. product-id 5. product-category 6. product-display-name 7. labels 8. bounding-poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` columns are required. All other columns are optional. If the `ProductSet` or `Product` specified by the `product-set-id` and `product-id` values does not exist, then the system will create a new `ProductSet` or `Product` for the image. In this case, the `product-display-name` column refers to [display_name][google.cloud.vision.v1.Product.display_name], the `product-category` column refers to [product_category][google.cloud.vision.v1.Product.product_category], and the `labels` column refers to [product_labels][google.cloud.vision.v1.Product.product_labels]. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system sets the [display_name][google.cloud.vision.v1.Product.display_name] field for the product to a space (" "). You can update the `display_name` later by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. The `labels` column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: "key_1=value_1,key_2=value_2,...,key_n=value_n" The `bounding-poly` column (optional) identifies one region of interest from the image in the same manner as `CreateReferenceImage`. If you do not specify the `bounding-poly` column, then the system will try to detect regions of interest automatically. At most one `bounding-poly` column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the `bounding-poly` values for each region of interest. The `bounding-poly` column must contain an even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP). }" + variable="data" type="array"/> - - getUpdateTime - \Google\Cloud\Vision\V1\OperationMetadata::getUpdateTime() + + getCsvFileUri + \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::getCsvFileUri() - - The time when the operation result was last updated. - Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 6;</code> + + The Google Cloud Storage URI of the input csv file. + The URI must start with `gs://`. +The format of the input csv file should be one image per line. +In each line, there are 8 columns. +1. image-uri +2. image-id +3. product-set-id +4. product-id +5. product-category +6. product-display-name +7. labels +8. bounding-poly +The `image-uri`, `product-set-id`, `product-id`, and `product-category` +columns are required. All other columns are optional. +If the `ProductSet` or `Product` specified by the `product-set-id` and +`product-id` values does not exist, then the system will create a new +`ProductSet` or `Product` for the image. In this case, the +`product-display-name` column refers to +[display_name][google.cloud.vision.v1.Product.display_name], the +`product-category` column refers to +[product_category][google.cloud.vision.v1.Product.product_category], and +the `labels` column refers to +[product_labels][google.cloud.vision.v1.Product.product_labels]. +The `image-id` column is optional but must be unique if provided. If it is +empty, the system will automatically assign a unique id to the image. +The `product-display-name` column is optional. If it is empty, the system +sets the [display_name][google.cloud.vision.v1.Product.display_name] field +for the product to a space (" "). You can update the `display_name` later +by using the API. +If a `Product` with the specified `product-id` already exists, then the +system ignores the `product-display-name`, `product-category`, and `labels` +columns. +The `labels` column (optional) is a line containing a list of +comma-separated key-value pairs, in the following format: + "key_1=value_1,key_2=value_2,...,key_n=value_n" +The `bounding-poly` column (optional) identifies one region of +interest from the image in the same manner as `CreateReferenceImage`. If +you do not specify the `bounding-poly` column, then the system will try to +detect regions of interest automatically. +At most one `bounding-poly` column is allowed per line. If the image +contains multiple regions of interest, add a line to the CSV file that +includes the same product information, and the `bounding-poly` values for +each region of interest. +The `bounding-poly` column must contain an even number of comma-separated +numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use +non-negative integers for absolute bounding polygons, and float values +in [0, 1] for normalized bounding polygons. +The system will resize the image if the image resolution is too +large to process (larger than 20MP). + +Generated from protobuf field <code>string csv_file_uri = 1;</code> + type="string"/> - - hasUpdateTime - \Google\Cloud\Vision\V1\OperationMetadata::hasUpdateTime() - - - - - - - - - - clearUpdateTime - \Google\Cloud\Vision\V1\OperationMetadata::clearUpdateTime() - - - - - - - - - - setUpdateTime - \Google\Cloud\Vision\V1\OperationMetadata::setUpdateTime() + + setCsvFileUri + \Google\Cloud\Vision\V1\ImportProductSetsGcsSource::setCsvFileUri() - + var - \Google\Protobuf\Timestamp + string - - The time when the operation result was last updated. - Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 6;</code> + + The Google Cloud Storage URI of the input csv file. + The URI must start with `gs://`. +The format of the input csv file should be one image per line. +In each line, there are 8 columns. +1. image-uri +2. image-id +3. product-set-id +4. product-id +5. product-category +6. product-display-name +7. labels +8. bounding-poly +The `image-uri`, `product-set-id`, `product-id`, and `product-category` +columns are required. All other columns are optional. +If the `ProductSet` or `Product` specified by the `product-set-id` and +`product-id` values does not exist, then the system will create a new +`ProductSet` or `Product` for the image. In this case, the +`product-display-name` column refers to +[display_name][google.cloud.vision.v1.Product.display_name], the +`product-category` column refers to +[product_category][google.cloud.vision.v1.Product.product_category], and +the `labels` column refers to +[product_labels][google.cloud.vision.v1.Product.product_labels]. +The `image-id` column is optional but must be unique if provided. If it is +empty, the system will automatically assign a unique id to the image. +The `product-display-name` column is optional. If it is empty, the system +sets the [display_name][google.cloud.vision.v1.Product.display_name] field +for the product to a space (" "). You can update the `display_name` later +by using the API. +If a `Product` with the specified `product-id` already exists, then the +system ignores the `product-display-name`, `product-category`, and `labels` +columns. +The `labels` column (optional) is a line containing a list of +comma-separated key-value pairs, in the following format: + "key_1=value_1,key_2=value_2,...,key_n=value_n" +The `bounding-poly` column (optional) identifies one region of +interest from the image in the same manner as `CreateReferenceImage`. If +you do not specify the `bounding-poly` column, then the system will try to +detect regions of interest automatically. +At most one `bounding-poly` column is allowed per line. If the image +contains multiple regions of interest, add a line to the CSV file that +includes the same product information, and the `bounding-poly` values for +each region of interest. +The `bounding-poly` column must contain an even number of comma-separated +numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use +non-negative integers for absolute bounding polygons, and float values +in [0, 1] for normalized bounding polygons. +The system will resize the image if the image resolution is too +large to process (larger than 20MP). + +Generated from protobuf field <code>string csv_file_uri = 1;</code> + variable="var" type="string"/> - + @@ -28503,56 +15277,13 @@ Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVer - - OperationMetadata_State - \Google\Cloud\Vision\V1\OperationMetadata_State - - This class is deprecated. Use Google\Cloud\Vision\V1\OperationMetadata\State instead. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - OutputConfig - \Google\Cloud\Vision\V1\OutputConfig + ImportProductSetsInputConfig + \Google\Cloud\Vision\V1\ImportProductSetsInputConfig - The desired output location and metadata. - Generated from protobuf message <code>google.cloud.vision.v1.OutputConfig</code> + The input content for the `ImportProductSets` method. + Generated from protobuf message <code>google.cloud.vision.v1.ImportProductSetsInputConfig</code> \Google\Protobuf\Internal\Message - - gcs_destination - \Google\Cloud\Vision\V1\OutputConfig::$gcs_destination - null - - The Google Cloud Storage location to write the output(s) to. - Generated from protobuf field <code>.google.cloud.vision.v1.GcsDestination gcs_destination = 1;</code> - - - - - - batch_size - \Google\Cloud\Vision\V1\OutputConfig::$batch_size - 0 - - The max number of response protos to put into each output JSON file on -Google Cloud Storage. - The valid range is [1, 100]. If not specified, the default value is 20. -For example, for one pdf file with 100 pages, 100 response protos will -be generated. If `batch_size` = 20, then 5 json files each -containing 20 response protos will be written under the prefix -`gcs_destination`.`uri`. -Currently, batch_size only applies to GcsDestination, with potential future -support for other output configurations. - -Generated from protobuf field <code>int32 batch_size = 2;</code> + + source + \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::$source + + + + - + __construct - \Google\Cloud\Vision\V1\OutputConfig::__construct() + \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::__construct() - + data - NULL + null array - + Constructor. - - getGcsDestination - \Google\Cloud\Vision\V1\OutputConfig::getGcsDestination() - - - The Google Cloud Storage location to write the output(s) to. - Generated from protobuf field <code>.google.cloud.vision.v1.GcsDestination gcs_destination = 1;</code> - - - - - - - hasGcsDestination - \Google\Cloud\Vision\V1\OutputConfig::hasGcsDestination() - - - - - - - - - - clearGcsDestination - \Google\Cloud\Vision\V1\OutputConfig::clearGcsDestination() - - - - - - - - - - setGcsDestination - \Google\Cloud\Vision\V1\OutputConfig::setGcsDestination() - - - var - - \Google\Cloud\Vision\V1\GcsDestination - - - - The Google Cloud Storage location to write the output(s) to. - Generated from protobuf field <code>.google.cloud.vision.v1.GcsDestination gcs_destination = 1;</code> - - - - - - - - getBatchSize - \Google\Cloud\Vision\V1\OutputConfig::getBatchSize() - - - The max number of response protos to put into each output JSON file on -Google Cloud Storage. - The valid range is [1, 100]. If not specified, the default value is 20. -For example, for one pdf file with 100 pages, 100 response protos will -be generated. If `batch_size` = 20, then 5 json files each -containing 20 response protos will be written under the prefix -`gcs_destination`.`uri`. -Currently, batch_size only applies to GcsDestination, with potential future -support for other output configurations. - -Generated from protobuf field <code>int32 batch_size = 2;</code> + + getGcsSource + \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::getGcsSource() + + + The Google Cloud Storage location for a csv file which preserves a list +of ImportProductSetRequests in each line. + Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsGcsSource gcs_source = 1;</code> + type="\Google\Cloud\Vision\V1\ImportProductSetsGcsSource|null"/> - - setBatchSize - \Google\Cloud\Vision\V1\OutputConfig::setBatchSize() + + hasGcsSource + \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::hasGcsSource() - + + + + + + + + + setGcsSource + \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::setGcsSource() + + var - int + \Google\Cloud\Vision\V1\ImportProductSetsGcsSource - - The max number of response protos to put into each output JSON file on -Google Cloud Storage. - The valid range is [1, 100]. If not specified, the default value is 20. -For example, for one pdf file with 100 pages, 100 response protos will -be generated. If `batch_size` = 20, then 5 json files each -containing 20 response protos will be written under the prefix -`gcs_destination`.`uri`. -Currently, batch_size only applies to GcsDestination, with potential future -support for other output configurations. - -Generated from protobuf field <code>int32 batch_size = 2;</code> + + The Google Cloud Storage location for a csv file which preserves a list +of ImportProductSetRequests in each line. + Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsGcsSource gcs_source = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\ImportProductSetsGcsSource"/> + + + + getSource + \Google\Cloud\Vision\V1\ImportProductSetsInputConfig::getSource() + + + + + + + @@ -28741,7 +15400,7 @@ Generated from protobuf field <code>int32 batch_size = 2;</code> - + @@ -28759,12 +15418,13 @@ Generated from protobuf field <code>int32 batch_size = 2;</code> - Page - \Google\Cloud\Vision\V1\Page + ImportProductSetsRequest + \Google\Cloud\Vision\V1\ImportProductSetsRequest - Detected page from OCR. - Generated from protobuf message <code>google.cloud.vision.v1.Page</code> + Request message for the `ImportProductSets` method. + Generated from protobuf message <code>google.cloud.vision.v1.ImportProductSetsRequest</code> \Google\Protobuf\Internal\Message - - property - \Google\Cloud\Vision\V1\Page::$property - null - - Additional information detected on the page. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - - + + parent + \Google\Cloud\Vision\V1\ImportProductSetsRequest::$parent + '' + + Required. The project in which the ProductSets should be imported. + Format is `projects/PROJECT_ID/locations/LOC_ID`. - - width - \Google\Cloud\Vision\V1\Page::$width - 0 - - Page width. For PDFs the unit is points. For images (including -TIFFs) the unit is pixels. - Generated from protobuf field <code>int32 width = 2;</code> +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - height - \Google\Cloud\Vision\V1\Page::$height - 0 - - Page height. For PDFs the unit is points. For images (including -TIFFs) the unit is pixels. - Generated from protobuf field <code>int32 height = 3;</code> + + input_config + \Google\Cloud\Vision\V1\ImportProductSetsRequest::$input_config + null + + Required. The input content for the list of requests. + Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - blocks - \Google\Cloud\Vision\V1\Page::$blocks + + + build + \Google\Cloud\Vision\V1\ImportProductSetsRequest::build() + + + parent - - List of blocks of text, images etc on this page. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Block blocks = 4;</code> - + string + - + + inputConfig + + \Google\Cloud\Vision\V1\ImportProductSetsInputConfig + - - confidence - \Google\Cloud\Vision\V1\Page::$confidence - 0.0 - - Confidence of the OCR results on the page. Range [0, 1]. - Generated from protobuf field <code>float confidence = 5;</code> - + + + + + + + + - + - - + __construct - \Google\Cloud\Vision\V1\Page::__construct() + \Google\Cloud\Vision\V1\ImportProductSetsRequest::__construct() - + data - NULL + null array - + Constructor. - - getProperty - \Google\Cloud\Vision\V1\Page::getProperty() + + getParent + \Google\Cloud\Vision\V1\ImportProductSetsRequest::getParent() - - Additional information detected on the page. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + Required. The project in which the ProductSets should be imported. + Format is `projects/PROJECT_ID/locations/LOC_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + type="string"/> - - hasProperty - \Google\Cloud\Vision\V1\Page::hasProperty() - - - - - - - - - - clearProperty - \Google\Cloud\Vision\V1\Page::clearProperty() - - - - - - - - - - setProperty - \Google\Cloud\Vision\V1\Page::setProperty() + + setParent + \Google\Cloud\Vision\V1\ImportProductSetsRequest::setParent() - + var - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty + string - - Additional information detected on the page. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + Required. The project in which the ProductSets should be imported. + Format is `projects/PROJECT_ID/locations/LOC_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + variable="var" type="string"/> - - getWidth - \Google\Cloud\Vision\V1\Page::getWidth() + + getInputConfig + \Google\Cloud\Vision\V1\ImportProductSetsRequest::getInputConfig() + + + Required. The input content for the list of requests. + Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + + + + + + hasInputConfig + \Google\Cloud\Vision\V1\ImportProductSetsRequest::hasInputConfig() + + + + + + + + + + clearInputConfig + \Google\Cloud\Vision\V1\ImportProductSetsRequest::clearInputConfig() - - Page width. For PDFs the unit is points. For images (including -TIFFs) the unit is pixels. - Generated from protobuf field <code>int32 width = 2;</code> - - + + + + - - setWidth - \Google\Cloud\Vision\V1\Page::setWidth() + + setInputConfig + \Google\Cloud\Vision\V1\ImportProductSetsRequest::setInputConfig() - + var - int + \Google\Cloud\Vision\V1\ImportProductSetsInputConfig - - Page width. For PDFs the unit is points. For images (including -TIFFs) the unit is pixels. - Generated from protobuf field <code>int32 width = 2;</code> + + Required. The input content for the list of requests. + Generated from protobuf field <code>.google.cloud.vision.v1.ImportProductSetsInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];</code> + variable="var" type="\Google\Cloud\Vision\V1\ImportProductSetsInputConfig"/> - - getHeight - \Google\Cloud\Vision\V1\Page::getHeight() - - - Page height. For PDFs the unit is points. For images (including -TIFFs) the unit is pixels. - Generated from protobuf field <code>int32 height = 3;</code> + + + + + + + + + + + name="package" + description="Application" + /> + + + + + + + + + + + + + ImportProductSetsResponse + \Google\Cloud\Vision\V1\ImportProductSetsResponse + + Response message for the `ImportProductSets` method. + This message is returned by the +[google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] +method in the returned +[google.longrunning.Operation.response][google.longrunning.Operation.response] +field. + +Generated from protobuf message <code>google.cloud.vision.v1.ImportProductSetsResponse</code> + - + \Google\Protobuf\Internal\Message + + + + reference_images + \Google\Cloud\Vision\V1\ImportProductSetsResponse::$reference_images + + + The list of reference_images that are imported successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> + - - setHeight - \Google\Cloud\Vision\V1\Page::setHeight() - - - var + + + + statuses + \Google\Cloud\Vision\V1\ImportProductSetsResponse::$statuses - int + + The rpc status for each ImportProductSet request, including both successes +and errors. + The number of statuses here matches the number of lines in the csv file, +and statuses[i] stores the success or failure status of processing the i-th +line of the csv, starting from line 0. + +Generated from protobuf field <code>repeated .google.rpc.Status statuses = 2;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\ImportProductSetsResponse::__construct() + + + data + null + array - - Page height. For PDFs the unit is points. For images (including -TIFFs) the unit is pixels. - Generated from protobuf field <code>int32 height = 3;</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\ReferenceImage[] $reference_images The list of reference_images that are imported successfully. @type \Google\Rpc\Status[] $statuses The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. }" + variable="data" type="array"/> - - getBlocks - \Google\Cloud\Vision\V1\Page::getBlocks() + + getReferenceImages + \Google\Cloud\Vision\V1\ImportProductSetsResponse::getReferenceImages() - - List of blocks of text, images etc on this page. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Block blocks = 4;</code> + + The list of reference_images that are imported successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\ReferenceImage>"/> - - setBlocks - \Google\Cloud\Vision\V1\Page::setBlocks() + + setReferenceImages + \Google\Cloud\Vision\V1\ImportProductSetsResponse::setReferenceImages() - + var - \Google\Cloud\Vision\V1\Block[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\ReferenceImage[] - - List of blocks of text, images etc on this page. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Block blocks = 4;</code> + + The list of reference_images that are imported successfully. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\ReferenceImage[]"/> - - getConfidence - \Google\Cloud\Vision\V1\Page::getConfidence() + + getStatuses + \Google\Cloud\Vision\V1\ImportProductSetsResponse::getStatuses() - - Confidence of the OCR results on the page. Range [0, 1]. - Generated from protobuf field <code>float confidence = 5;</code> + + The rpc status for each ImportProductSet request, including both successes +and errors. + The number of statuses here matches the number of lines in the csv file, +and statuses[i] stores the success or failure status of processing the i-th +line of the csv, starting from line 0. + +Generated from protobuf field <code>repeated .google.rpc.Status statuses = 2;</code> + type="\Google\Protobuf\RepeatedField<\Google\Rpc\Status>"/> - - setConfidence - \Google\Cloud\Vision\V1\Page::setConfidence() + + setStatuses + \Google\Cloud\Vision\V1\ImportProductSetsResponse::setStatuses() - + var - float + \Google\Rpc\Status[] - - Confidence of the OCR results on the page. Range [0, 1]. - Generated from protobuf field <code>float confidence = 5;</code> + + The rpc status for each ImportProductSet request, including both successes +and errors. + The number of statuses here matches the number of lines in the csv file, +and statuses[i] stores the success or failure status of processing the i-th +line of the csv, starting from line 0. + +Generated from protobuf field <code>repeated .google.rpc.Status statuses = 2;</code> + variable="var" type="\Google\Rpc\Status[]"/> - + @@ -29103,156 +15834,137 @@ TIFFs) the unit is pixels. - - Paragraph - \Google\Cloud\Vision\V1\Paragraph - - Structural unit of text representing a number of words in certain order. - Generated from protobuf message <code>google.cloud.vision.v1.Paragraph</code> - - - - \Google\Protobuf\Internal\Message - - - - property - \Google\Cloud\Vision\V1\Paragraph::$property - null - - Additional information detected for the paragraph. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - - - - - bounding_box - \Google\Cloud\Vision\V1\Paragraph::$bounding_box - null - - The bounding box for the paragraph. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: - * when the text is horizontal it might look like: - 0----1 - | | - 3----2 - * when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). + + + InputConfig + \Google\Cloud\Vision\V1\InputConfig + + The desired input location and metadata. + Generated from protobuf message <code>google.cloud.vision.v1.InputConfig</code> + + -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + \Google\Protobuf\Internal\Message + + + + gcs_source + \Google\Cloud\Vision\V1\InputConfig::$gcs_source + null + + The Google Cloud Storage location to read the input from. + Generated from protobuf field <code>.google.cloud.vision.v1.GcsSource gcs_source = 1;</code> - - words - \Google\Cloud\Vision\V1\Paragraph::$words - - - List of all words in this paragraph. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Word words = 3;</code> + + content + \Google\Cloud\Vision\V1\InputConfig::$content + '' + + File content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary +representation, whereas JSON representations use base64. +Currently, this field only works for BatchAnnotateFiles requests. It does +not work for AsyncBatchAnnotateFiles requests. + +Generated from protobuf field <code>bytes content = 3;</code> - - confidence - \Google\Cloud\Vision\V1\Paragraph::$confidence - 0.0 - - Confidence of the OCR results for the paragraph. Range [0, 1]. - Generated from protobuf field <code>float confidence = 4;</code> + + mime_type + \Google\Cloud\Vision\V1\InputConfig::$mime_type + '' + + The type of the file. Currently only "application/pdf", "image/tiff" and +"image/gif" are supported. Wildcards are not supported. + Generated from protobuf field <code>string mime_type = 2;</code> - + __construct - \Google\Cloud\Vision\V1\Paragraph::__construct() + \Google\Cloud\Vision\V1\InputConfig::__construct() - + data - NULL + null array - + Constructor. - - getProperty - \Google\Cloud\Vision\V1\Paragraph::getProperty() + + getGcsSource + \Google\Cloud\Vision\V1\InputConfig::getGcsSource() - - Additional information detected for the paragraph. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + The Google Cloud Storage location to read the input from. + Generated from protobuf field <code>.google.cloud.vision.v1.GcsSource gcs_source = 1;</code> + type="\Google\Cloud\Vision\V1\GcsSource|null"/> - - hasProperty - \Google\Cloud\Vision\V1\Paragraph::hasProperty() + + hasGcsSource + \Google\Cloud\Vision\V1\InputConfig::hasGcsSource() - + - - clearProperty - \Google\Cloud\Vision\V1\Paragraph::clearProperty() + + clearGcsSource + \Google\Cloud\Vision\V1\InputConfig::clearGcsSource() - + - - setProperty - \Google\Cloud\Vision\V1\Paragraph::setProperty() + + setGcsSource + \Google\Cloud\Vision\V1\InputConfig::setGcsSource() - + var - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty + \Google\Cloud\Vision\V1\GcsSource - - Additional information detected for the paragraph. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + The Google Cloud Storage location to read the input from. + Generated from protobuf field <code>.google.cloud.vision.v1.GcsSource gcs_source = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\GcsSource"/> - - getBoundingBox - \Google\Cloud\Vision\V1\Paragraph::getBoundingBox() + + getContent + \Google\Cloud\Vision\V1\InputConfig::getContent() - - The bounding box for the paragraph. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: - * when the text is horizontal it might look like: - 0----1 - | | - 3----2 - * when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). + + File content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary +representation, whereas JSON representations use base64. +Currently, this field only works for BatchAnnotateFiles requests. It does +not work for AsyncBatchAnnotateFiles requests. -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> +Generated from protobuf field <code>bytes content = 3;</code> + type="string"/> - - hasBoundingBox - \Google\Cloud\Vision\V1\Paragraph::hasBoundingBox() - - - - - - - - - - clearBoundingBox - \Google\Cloud\Vision\V1\Paragraph::clearBoundingBox() - - - - - - - - - - setBoundingBox - \Google\Cloud\Vision\V1\Paragraph::setBoundingBox() + + setContent + \Google\Cloud\Vision\V1\InputConfig::setContent() - + var - \Google\Cloud\Vision\V1\BoundingPoly + string - - The bounding box for the paragraph. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: - * when the text is horizontal it might look like: - 0----1 - | | - 3----2 - * when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> - - - - - - - - getWords - \Google\Cloud\Vision\V1\Paragraph::getWords() - - - List of all words in this paragraph. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Word words = 3;</code> - - - - - - - setWords - \Google\Cloud\Vision\V1\Paragraph::setWords() - - - var - - \Google\Cloud\Vision\V1\Word[]|\Google\Protobuf\Internal\RepeatedField - + + File content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary +representation, whereas JSON representations use base64. +Currently, this field only works for BatchAnnotateFiles requests. It does +not work for AsyncBatchAnnotateFiles requests. - - List of all words in this paragraph. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Word words = 3;</code> +Generated from protobuf field <code>bytes content = 3;</code> + variable="var" type="string"/> - - getConfidence - \Google\Cloud\Vision\V1\Paragraph::getConfidence() + + getMimeType + \Google\Cloud\Vision\V1\InputConfig::getMimeType() - - Confidence of the OCR results for the paragraph. Range [0, 1]. - Generated from protobuf field <code>float confidence = 4;</code> + + The type of the file. Currently only "application/pdf", "image/tiff" and +"image/gif" are supported. Wildcards are not supported. + Generated from protobuf field <code>string mime_type = 2;</code> + type="string"/> - - setConfidence - \Google\Cloud\Vision\V1\Paragraph::setConfidence() + + setMimeType + \Google\Cloud\Vision\V1\InputConfig::setMimeType() - + var - float + string - - Confidence of the OCR results for the paragraph. Range [0, 1]. - Generated from protobuf field <code>float confidence = 4;</code> + + The type of the file. Currently only "application/pdf", "image/tiff" and +"image/gif" are supported. Wildcards are not supported. + Generated from protobuf field <code>string mime_type = 2;</code> + variable="var" type="string"/> - + @@ -29457,15 +16089,13 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - - Position - \Google\Cloud\Vision\V1\Position - - A 3D position in the image, used primarily for Face detection landmarks. - A valid Position must have both x and y coordinates. -The position coordinates are in the same scale as the original image. - -Generated from protobuf message <code>google.cloud.vision.v1.Position</code> + + + LatLongRect + \Google\Cloud\Vision\V1\LatLongRect + + Rectangle determined by min and max `LatLng` pairs. + Generated from protobuf message <code>google.cloud.vision.v1.LatLongRect</code> \Google\Protobuf\Internal\Message - - x - \Google\Cloud\Vision\V1\Position::$x - 0.0 - - X coordinate. - Generated from protobuf field <code>float x = 1;</code> - - - - - - y - \Google\Cloud\Vision\V1\Position::$y - 0.0 - - Y coordinate. - Generated from protobuf field <code>float y = 2;</code> + + min_lat_lng + \Google\Cloud\Vision\V1\LatLongRect::$min_lat_lng + null + + Min lat/long pair. + Generated from protobuf field <code>.google.type.LatLng min_lat_lng = 1;</code> - - z - \Google\Cloud\Vision\V1\Position::$z - 0.0 - - Z coordinate (or depth). - Generated from protobuf field <code>float z = 3;</code> + + max_lat_lng + \Google\Cloud\Vision\V1\LatLongRect::$max_lat_lng + null + + Max lat/long pair. + Generated from protobuf field <code>.google.type.LatLng max_lat_lng = 2;</code> - + __construct - \Google\Cloud\Vision\V1\Position::__construct() + \Google\Cloud\Vision\V1\LatLongRect::__construct() - + data - NULL + null array - + Constructor. - - getX - \Google\Cloud\Vision\V1\Position::getX() + + getMinLatLng + \Google\Cloud\Vision\V1\LatLongRect::getMinLatLng() - - X coordinate. - Generated from protobuf field <code>float x = 1;</code> + + Min lat/long pair. + Generated from protobuf field <code>.google.type.LatLng min_lat_lng = 1;</code> + type="\Google\Type\LatLng|null"/> + + + + hasMinLatLng + \Google\Cloud\Vision\V1\LatLongRect::hasMinLatLng() + + + + + + + + + + clearMinLatLng + \Google\Cloud\Vision\V1\LatLongRect::clearMinLatLng() + + + + + + - setX - \Google\Cloud\Vision\V1\Position::setX() + setMinLatLng + \Google\Cloud\Vision\V1\LatLongRect::setMinLatLng() var - float + \Google\Type\LatLng - X coordinate. - Generated from protobuf field <code>float x = 1;</code> + Min lat/long pair. + Generated from protobuf field <code>.google.type.LatLng min_lat_lng = 1;</code> + variable="var" type="\Google\Type\LatLng"/> - getY - \Google\Cloud\Vision\V1\Position::getY() + getMaxLatLng + \Google\Cloud\Vision\V1\LatLongRect::getMaxLatLng() - Y coordinate. - Generated from protobuf field <code>float y = 2;</code> + Max lat/long pair. + Generated from protobuf field <code>.google.type.LatLng max_lat_lng = 2;</code> + type="\Google\Type\LatLng|null"/> - - setY - \Google\Cloud\Vision\V1\Position::setY() + + hasMaxLatLng + \Google\Cloud\Vision\V1\LatLongRect::hasMaxLatLng() - - var - - float - - - - Y coordinate. - Generated from protobuf field <code>float y = 2;</code> - - - + + + + - - getZ - \Google\Cloud\Vision\V1\Position::getZ() + + clearMaxLatLng + \Google\Cloud\Vision\V1\LatLongRect::clearMaxLatLng() - - Z coordinate (or depth). - Generated from protobuf field <code>float z = 3;</code> - - + + + + - - setZ - \Google\Cloud\Vision\V1\Position::setZ() + + setMaxLatLng + \Google\Cloud\Vision\V1\LatLongRect::setMaxLatLng() - + var - float + \Google\Type\LatLng - - Z coordinate (or depth). - Generated from protobuf field <code>float z = 3;</code> + + Max lat/long pair. + Generated from protobuf field <code>.google.type.LatLng max_lat_lng = 2;</code> + variable="var" type="\Google\Type\LatLng"/> - + @@ -29667,155 +16290,139 @@ Generated from protobuf message <code>google.cloud.vision.v1.Position</ - - - + + + + + + + + + + Likelihood + \Google\Cloud\Vision\V1\Likelihood + + A bucketized representation of likelihood, which is intended to give clients +highly stable results across model upgrades. + Protobuf type <code>google.cloud.vision.v1.Likelihood</code> + + + + + + + UNKNOWN + \Google\Cloud\Vision\V1\Likelihood::UNKNOWN + 0 + + Unknown likelihood. + Generated from protobuf enum <code>UNKNOWN = 0;</code> + + + + + + VERY_UNLIKELY + \Google\Cloud\Vision\V1\Likelihood::VERY_UNLIKELY + 1 + + It is very unlikely. + Generated from protobuf enum <code>VERY_UNLIKELY = 1;</code> + + + + + + UNLIKELY + \Google\Cloud\Vision\V1\Likelihood::UNLIKELY + 2 + + It is unlikely. + Generated from protobuf enum <code>UNLIKELY = 2;</code> + + + + + + POSSIBLE + \Google\Cloud\Vision\V1\Likelihood::POSSIBLE + 3 + + It is possible. + Generated from protobuf enum <code>POSSIBLE = 3;</code> + - - - - - KeyValue - \Google\Cloud\Vision\V1\Product\KeyValue - - A product label represented as a key-value pair. - Generated from protobuf message <code>google.cloud.vision.v1.Product.KeyValue</code> - - + - \Google\Protobuf\Internal\Message - - - - key - \Google\Cloud\Vision\V1\Product\KeyValue::$key - '' - - The key of the label attached to the product. Cannot be empty and cannot -exceed 128 bytes. - Generated from protobuf field <code>string key = 1;</code> + + LIKELY + \Google\Cloud\Vision\V1\Likelihood::LIKELY + 4 + + It is likely. + Generated from protobuf enum <code>LIKELY = 4;</code> - + - - value - \Google\Cloud\Vision\V1\Product\KeyValue::$value - '' - - The value of the label attached to the product. Cannot be empty and -cannot exceed 128 bytes. - Generated from protobuf field <code>string value = 2;</code> + + VERY_LIKELY + \Google\Cloud\Vision\V1\Likelihood::VERY_LIKELY + 5 + + It is very likely. + Generated from protobuf enum <code>VERY_LIKELY = 5;</code> - + - - __construct - \Google\Cloud\Vision\V1\Product\KeyValue::__construct() - - - data - NULL - array - - - - Constructor. + + valueToName + \Google\Cloud\Vision\V1\Likelihood::$valueToName + [self::UNKNOWN => 'UNKNOWN', self::VERY_UNLIKELY => 'VERY_UNLIKELY', self::UNLIKELY => 'UNLIKELY', self::POSSIBLE => 'POSSIBLE', self::LIKELY => 'LIKELY', self::VERY_LIKELY => 'VERY_LIKELY'] + + - - - - - - - getKey - \Google\Cloud\Vision\V1\Product\KeyValue::getKey() - - - The key of the label attached to the product. Cannot be empty and cannot -exceed 128 bytes. - Generated from protobuf field <code>string key = 1;</code> - - + - + - - setKey - \Google\Cloud\Vision\V1\Product\KeyValue::setKey() + + + name + \Google\Cloud\Vision\V1\Likelihood::name() - - var + + value - string + mixed - - The key of the label attached to the product. Cannot be empty and cannot -exceed 128 bytes. - Generated from protobuf field <code>string key = 1;</code> - - - - - - - - getValue - \Google\Cloud\Vision\V1\Product\KeyValue::getValue() - - - The value of the label attached to the product. Cannot be empty and -cannot exceed 128 bytes. - Generated from protobuf field <code>string value = 2;</code> - - + + + + - - setValue - \Google\Cloud\Vision\V1\Product\KeyValue::setValue() + + value + \Google\Cloud\Vision\V1\Likelihood::value() - - var + + name - string + mixed - - The value of the label attached to the product. Cannot be empty and -cannot exceed 128 bytes. - Generated from protobuf field <code>string value = 2;</code> - - - + + + + @@ -29825,7 +16432,7 @@ cannot exceed 128 bytes. - + @@ -29843,12 +16450,13 @@ cannot exceed 128 bytes. + - Product - \Google\Cloud\Vision\V1\Product + ListProductSetsRequest + \Google\Cloud\Vision\V1\ListProductSetsRequest - A Product contains ReferenceImages. - Generated from protobuf message <code>google.cloud.vision.v1.Product</code> + Request message for the `ListProductSets` method. + Generated from protobuf message <code>google.cloud.vision.v1.ListProductSetsRequest</code> \Google\Protobuf\Internal\Message - - name - \Google\Cloud\Vision\V1\Product::$name - '' - - The resource name of the product. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. -This field is ignored when creating a product. - -Generated from protobuf field <code>string name = 1;</code> - - - - - - display_name - \Google\Cloud\Vision\V1\Product::$display_name + + parent + \Google\Cloud\Vision\V1\ListProductSetsRequest::$parent '' - - The user-provided name for this Product. Must not be empty. Must be at most -4096 characters long. - Generated from protobuf field <code>string display_name = 2;</code> - - - + + Required. The project from which ProductSets should be listed. + Format is `projects/PROJECT_ID/locations/LOC_ID`. - - description - \Google\Cloud\Vision\V1\Product::$description - '' - - User-provided metadata to be stored with this product. Must be at most 4096 -characters long. - Generated from protobuf field <code>string description = 3;</code> +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - product_category - \Google\Cloud\Vision\V1\Product::$product_category - '' - - Immutable. The category for the product identified by the reference image. - This should be one of "homegoods-v2", "apparel-v2", "toys-v2", -"packagedgoods-v1" or "general-v1". The legacy categories "homegoods", -"apparel", and "toys" are still supported, but these should not be used for -new products. - -Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> + + page_size + \Google\Cloud\Vision\V1\ListProductSetsRequest::$page_size + 0 + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> - - product_labels - \Google\Cloud\Vision\V1\Product::$product_labels - - - Key-value pairs that can be attached to a product. At query time, -constraints can be specified based on the product_labels. - Note that integer values can be provided as strings, e.g. "1199". Only -strings with integer values can match a range-based restriction which is -to be supported soon. -Multiple values can be assigned to the same key. One product may have up to -500 product_labels. -Notice that the total number of distinct product_labels over all products -in one ProductSet cannot exceed 1M, otherwise the product search pipeline -will refuse to work for that ProductSet. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;</code> + + page_token + \Google\Cloud\Vision\V1\ListProductSetsRequest::$page_token + '' + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string page_token = 3;</code> - + + build + \Google\Cloud\Vision\V1\ListProductSetsRequest::build() + + + parent + + string + + + + + + + + + + + + + __construct - \Google\Cloud\Vision\V1\Product::__construct() + \Google\Cloud\Vision\V1\ListProductSetsRequest::__construct() - + data - NULL + null array - + Constructor. - - getName - \Google\Cloud\Vision\V1\Product::getName() + + getParent + \Google\Cloud\Vision\V1\ListProductSetsRequest::getParent() - - The resource name of the product. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. -This field is ignored when creating a product. + + Required. The project from which ProductSets should be listed. + Format is `projects/PROJECT_ID/locations/LOC_ID`. -Generated from protobuf field <code>string name = 1;</code> +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - setName - \Google\Cloud\Vision\V1\Product::setName() + + setParent + \Google\Cloud\Vision\V1\ListProductSetsRequest::setParent() - + var string - - The resource name of the product. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. -This field is ignored when creating a product. + + Required. The project from which ProductSets should be listed. + Format is `projects/PROJECT_ID/locations/LOC_ID`. -Generated from protobuf field <code>string name = 1;</code> +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - getDisplayName - \Google\Cloud\Vision\V1\Product::getDisplayName() + + getPageSize + \Google\Cloud\Vision\V1\ListProductSetsRequest::getPageSize() - - The user-provided name for this Product. Must not be empty. Must be at most -4096 characters long. - Generated from protobuf field <code>string display_name = 2;</code> + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> + type="int"/> - - setDisplayName - \Google\Cloud\Vision\V1\Product::setDisplayName() + + setPageSize + \Google\Cloud\Vision\V1\ListProductSetsRequest::setPageSize() - + var - string + int - - The user-provided name for this Product. Must not be empty. Must be at most -4096 characters long. - Generated from protobuf field <code>string display_name = 2;</code> + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> + variable="var" type="int"/> - - getDescription - \Google\Cloud\Vision\V1\Product::getDescription() + + getPageToken + \Google\Cloud\Vision\V1\ListProductSetsRequest::getPageToken() - - User-provided metadata to be stored with this product. Must be at most 4096 -characters long. - Generated from protobuf field <code>string description = 3;</code> + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string page_token = 3;</code> - - setDescription - \Google\Cloud\Vision\V1\Product::setDescription() + + setPageToken + \Google\Cloud\Vision\V1\ListProductSetsRequest::setPageToken() - + var string - - User-provided metadata to be stored with this product. Must be at most 4096 -characters long. - Generated from protobuf field <code>string description = 3;</code> + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string page_token = 3;</code> - - getProductCategory - \Google\Cloud\Vision\V1\Product::getProductCategory() + + + + + + + + + + + + + + + + + + + + + + + + ListProductSetsResponse + \Google\Cloud\Vision\V1\ListProductSetsResponse + + Response message for the `ListProductSets` method. + Generated from protobuf message <code>google.cloud.vision.v1.ListProductSetsResponse</code> + + + + \Google\Protobuf\Internal\Message + + + + product_sets + \Google\Cloud\Vision\V1\ListProductSetsResponse::$product_sets + + + List of ProductSets. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSet product_sets = 1;</code> + + + + + + next_page_token + \Google\Cloud\Vision\V1\ListProductSetsResponse::$next_page_token + '' + + Token to retrieve the next page of results, or empty if there are no more +results in the list. + Generated from protobuf field <code>string next_page_token = 2;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\ListProductSetsResponse::__construct() - - Immutable. The category for the product identified by the reference image. - This should be one of "homegoods-v2", "apparel-v2", "toys-v2", -"packagedgoods-v1" or "general-v1". The legacy categories "homegoods", -"apparel", and "toys" are still supported, but these should not be used for -new products. + + data + null + array + -Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> + + Constructor. + + + + + + + + getProductSets + \Google\Cloud\Vision\V1\ListProductSetsResponse::getProductSets() + + + List of ProductSets. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSet product_sets = 1;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\ProductSet>"/> - - setProductCategory - \Google\Cloud\Vision\V1\Product::setProductCategory() + + setProductSets + \Google\Cloud\Vision\V1\ListProductSetsResponse::setProductSets() - + var - string - - - - Immutable. The category for the product identified by the reference image. - This should be one of "homegoods-v2", "apparel-v2", "toys-v2", -"packagedgoods-v1" or "general-v1". The legacy categories "homegoods", -"apparel", and "toys" are still supported, but these should not be used for -new products. + \Google\Cloud\Vision\V1\ProductSet[] + -Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> + + List of ProductSets. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSet product_sets = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\ProductSet[]"/> - - getProductLabels - \Google\Cloud\Vision\V1\Product::getProductLabels() + + getNextPageToken + \Google\Cloud\Vision\V1\ListProductSetsResponse::getNextPageToken() - - Key-value pairs that can be attached to a product. At query time, -constraints can be specified based on the product_labels. - Note that integer values can be provided as strings, e.g. "1199". Only -strings with integer values can match a range-based restriction which is -to be supported soon. -Multiple values can be assigned to the same key. One product may have up to -500 product_labels. -Notice that the total number of distinct product_labels over all products -in one ProductSet cannot exceed 1M, otherwise the product search pipeline -will refuse to work for that ProductSet. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;</code> + + Token to retrieve the next page of results, or empty if there are no more +results in the list. + Generated from protobuf field <code>string next_page_token = 2;</code> + type="string"/> - - setProductLabels - \Google\Cloud\Vision\V1\Product::setProductLabels() + + setNextPageToken + \Google\Cloud\Vision\V1\ListProductSetsResponse::setNextPageToken() - + var - \Google\Cloud\Vision\V1\Product\KeyValue[]|\Google\Protobuf\Internal\RepeatedField + string - - Key-value pairs that can be attached to a product. At query time, -constraints can be specified based on the product_labels. - Note that integer values can be provided as strings, e.g. "1199". Only -strings with integer values can match a range-based restriction which is -to be supported soon. -Multiple values can be assigned to the same key. One product may have up to -500 product_labels. -Notice that the total number of distinct product_labels over all products -in one ProductSet cannot exceed 1M, otherwise the product search pipeline -will refuse to work for that ProductSet. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;</code> + + Token to retrieve the next page of results, or empty if there are no more +results in the list. + Generated from protobuf field <code>string next_page_token = 2;</code> + variable="var" type="string"/> - + @@ -30222,1781 +16867,1091 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Produ - - Product_KeyValue - \Google\Cloud\Vision\V1\Product_KeyValue - - This class is deprecated. Use Google\Cloud\Vision\V1\Product\KeyValue instead. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ProductSearchClient - \Google\Cloud\Vision\V1\ProductSearchClient - - Service Description: Manages Products and ProductSets of reference images for use in product -search. It uses the following resource model: - + + ListProductsInProductSetRequest + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest + + Request message for the `ListProductsInProductSet` method. + Generated from protobuf message <code>google.cloud.vision.v1.ListProductsInProductSetRequest</code> - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - - SERVICE_NAME - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_NAME - 'google.cloud.vision.v1.ProductSearch' - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - The name of the service. - - - - - - - SERVICE_ADDRESS - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_ADDRESS - 'vision.googleapis.com' - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - The default address of the service. - - - - - - - - SERVICE_ADDRESS_TEMPLATE - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::SERVICE_ADDRESS_TEMPLATE - 'vision.UNIVERSE_DOMAIN' - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - The address template of the service. - - - - - - - DEFAULT_SERVICE_PORT - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::DEFAULT_SERVICE_PORT - 443 - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - The default port of the service. - - - - - - - CODEGEN_NAME - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::CODEGEN_NAME - 'gapic' - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - The name of the code generator, to be included in the agent header. - - - - - + \Google\Protobuf\Internal\Message - - serviceScopes - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$serviceScopes - ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud-vision'] - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - The default scopes required by the service. - - - - - - - locationNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$locationNameTemplate - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - - - - - - - productNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$productNameTemplate - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - - - - - - - productSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$productSetNameTemplate - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - - - - + + + name + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::$name + '' + + Required. The ProductSet resource for which to retrieve Products. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - - referenceImageNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$referenceImageNameTemplate - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - pathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$pathTemplateMap - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - + + page_size + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::$page_size + 0 + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> - - operationsClient - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::$operationsClient - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - + + page_token + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::$page_token + '' + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string page_token = 3;</code> - - - getClientDefaults - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getClientDefaults() - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - - - - - - - getLocationNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getLocationNameTemplate() + + + build + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::build() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - - - - + + name + + string + - - getProductNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductNameTemplate() - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + - + + + + - - getProductSetNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductSetNameTemplate() + + __construct + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::__construct() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - - - - + + data + null + array + - - getReferenceImageNameTemplate - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getReferenceImageNameTemplate() - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - + + Constructor. - + + - - getPathTemplateMap - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getPathTemplateMap() + + getName + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::getName() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - - - + + Required. The ProductSet resource for which to retrieve Products. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + - - locationName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::locationName() + + setName + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::setName() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - project + + var string - - location - - string - + + Required. The ProductSet resource for which to retrieve Products. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - - Formats a string containing the fully-qualified path to represent a location -resource. - +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - + variable="var" type="string"/> + description="" + type="$this"/> - - productName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::productName() + + getPageSize + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::getPageSize() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - project - - string - + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> + + - - location - - string - + - - product + + setPageSize + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::setPageSize() + + + var - string + int - - Formats a string containing the fully-qualified path to represent a product -resource. - + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> - - + variable="var" type="int"/> + description="" + type="$this"/> - - productSetName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::productSetName() + + getPageToken + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::getPageToken() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - project - - string - + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string page_token = 3;</code> + + - - location - - string - + - - productSet + + setPageToken + \Google\Cloud\Vision\V1\ListProductsInProductSetRequest::setPageToken() + + + var string - - Formats a string containing the fully-qualified path to represent a product_set -resource. - + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string page_token = 3;</code> - - + variable="var" type="string"/> + description="" + type="$this"/> - - referenceImageName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::referenceImageName() - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - project - - string - + + + + + + + + + + + + - - location - - string - - - product + + + + + + + + + + ListProductsInProductSetResponse + \Google\Cloud\Vision\V1\ListProductsInProductSetResponse + + Response message for the `ListProductsInProductSet` method. + Generated from protobuf message <code>google.cloud.vision.v1.ListProductsInProductSetResponse</code> + + + + \Google\Protobuf\Internal\Message + + + + products + \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::$products - string + + The list of Products. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> + + + + + + next_page_token + \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::$next_page_token + '' + + Token to retrieve the next page of results, or empty if there are no more +results in the list. + Generated from protobuf field <code>string next_page_token = 2;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::__construct() + + + data + null + array - - referenceImage + + Constructor. + + + + + + + + getProducts + \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::getProducts() + + + The list of Products. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> + + + + + + + setProducts + \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::setProducts() + + + var - string + \Google\Cloud\Vision\V1\Product[] - - Formats a string containing the fully-qualified path to represent a -reference_image resource. - + + The list of Products. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> - - - + variable="var" type="\Google\Cloud\Vision\V1\Product[]"/> + + + + + + getNextPageToken + \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::getNextPageToken() + + + Token to retrieve the next page of results, or empty if there are no more +results in the list. + Generated from protobuf field <code>string next_page_token = 2;</code> + - - parseName - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::parseName() + + setNextPageToken + \Google\Cloud\Vision\V1\ListProductsInProductSetResponse::setNextPageToken() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - formattedName + + var string - - template - null - string - - - - Parses a formatted name string and returns an associative array of the components in the name. - The following name formats are supported: -Template: Pattern -- location: projects/{project}/locations/{location} -- product: projects/{project}/locations/{location}/products/{product} -- productSet: projects/{project}/locations/{location}/productSets/{product_set} -- referenceImage: projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image} - -The optional $template argument can be supplied to specify a particular pattern, -and must match one of the templates listed above. If no $template argument is -provided, or if the $template argument does not match one of the templates -listed, then parseName will check each of the supported templates, and return -the first match. + + Token to retrieve the next page of results, or empty if there are no more +results in the list. + Generated from protobuf field <code>string next_page_token = 2;</code> - + description="" + variable="var" type="string"/> - + description="" + type="$this"/> - - getOperationsClient - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getOperationsClient() - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - Return an OperationsClient object with the same endpoint as $this. + + + + + + + + + + name="package" + description="Application" + /> + + + + + + + + + + + + + ListProductsRequest + \Google\Cloud\Vision\V1\ListProductsRequest + + Request message for the `ListProducts` method. + Generated from protobuf message <code>google.cloud.vision.v1.ListProductsRequest</code> + - + \Google\Protobuf\Internal\Message + + + + parent + \Google\Cloud\Vision\V1\ListProductsRequest::$parent + '' + + Required. The project OR ProductSet from which Products should be listed. + Format: +`projects/PROJECT_ID/locations/LOC_ID` - - resumeOperation - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::resumeOperation() +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + page_size + \Google\Cloud\Vision\V1\ListProductsRequest::$page_size + 0 + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> + + + + + + page_token + \Google\Cloud\Vision\V1\ListProductsRequest::$page_token + '' + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string page_token = 3;</code> + + + + + + + build + \Google\Cloud\Vision\V1\ListProductsRequest::build() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - operationName + + parent string - - methodName - null - string - - - - Resume an existing long running operation that was previously started by a long -running API method. If $methodName is not provided, or does not match a long -running API method, then the operation can still be resumed, but the -OperationResponse object will not deserialize the final response. + + - + description="Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` Please see {@see \Google\Cloud\Vision\V1\ProductSearchClient::locationName()} for help formatting this field." + variable="parent" type="string"/> + type="\Google\Cloud\Vision\V1\ListProductsRequest"/> + - + __construct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::__construct() + \Google\Cloud\Vision\V1\ListProductsRequest::__construct() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - options - [] + + data + null array - + Constructor. - + description="{ Optional. Data for populating the Message object. @type string $parent Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` @type int $page_size The maximum number of items to return. Default 10, maximum 100. @type string $page_token The next_page_token returned from a previous List request, if any. }" + variable="data" type="array"/> - - addProductToProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::addProductToProductSet() + + getParent + \Google\Cloud\Vision\V1\ListProductsRequest::getParent() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - name - - string - - - - product - - string - - - - optionalArgs - [] - array - - - - Adds a Product to the specified ProductSet. If the Product is already -present, no change is made. - One Product can be added to at most 100 ProductSets. - -Possible errors: - -* Returns NOT_FOUND if the Product or the ProductSet doesn't exist. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $formattedProduct = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $productSearchClient->addProductToProductSet($formattedName, $formattedProduct); -} finally { - $productSearchClient->close(); -} -``` - - - - + + Required. The project OR ProductSet from which Products should be listed. + Format: +`projects/PROJECT_ID/locations/LOC_ID` + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + - - createProduct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createProduct() + + setParent + \Google\Cloud\Vision\V1\ListProductsRequest::setParent() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - parent + + var string - - product - - \Google\Cloud\Vision\V1\Product - - - - optionalArgs - [] - array - - - - Creates and returns a new product resource. - Possible errors: - -* Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 -characters. -* Returns INVALID_ARGUMENT if description is longer than 4096 characters. -* Returns INVALID_ARGUMENT if product_category is missing or invalid. + + Required. The project OR ProductSet from which Products should be listed. + Format: +`projects/PROJECT_ID/locations/LOC_ID` -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - $product = new Product(); - $response = $productSearchClient->createProduct($formattedParent, $product); -} finally { - $productSearchClient->close(); -} -``` +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - + description="" + variable="var" type="string"/> - + type="$this"/> - - createProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createProductSet() + + getPageSize + \Google\Cloud\Vision\V1\ListProductsRequest::getPageSize() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - parent - - string - + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> + + - - productSet - - \Google\Cloud\Vision\V1\ProductSet - + - - optionalArgs - [] - array + + setPageSize + \Google\Cloud\Vision\V1\ListProductsRequest::setPageSize() + + + var + + int - - Creates and returns a new ProductSet resource. - Possible errors: - -* Returns INVALID_ARGUMENT if display_name is missing, or is longer than -4096 characters. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - $productSet = new ProductSet(); - $response = $productSearchClient->createProductSet($formattedParent, $productSet); -} finally { - $productSearchClient->close(); -} -``` + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> - - + description="" + variable="var" type="int"/> - + type="$this"/> - - createReferenceImage - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::createReferenceImage() + + getPageToken + \Google\Cloud\Vision\V1\ListProductsRequest::getPageToken() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - parent - - string - - - - referenceImage - - \Google\Cloud\Vision\V1\ReferenceImage - - - - optionalArgs - [] - array - - - - Creates and returns a new ReferenceImage resource. - The `bounding_poly` field is optional. If `bounding_poly` is not specified, -the system will try to detect regions of interest in the image that are -compatible with the product_category on the parent product. If it is -specified, detection is ALWAYS skipped. The system converts polygons into -non-rotated rectangles. - -Note that the pipeline will resize the image if the image resolution is too -large to process (above 50MP). - -Possible errors: - -* Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 -characters. -* Returns INVALID_ARGUMENT if the product does not exist. -* Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing -compatible with the parent product's product_category is detected. -* Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $referenceImage = new ReferenceImage(); - $response = $productSearchClient->createReferenceImage($formattedParent, $referenceImage); -} finally { - $productSearchClient->close(); -} -``` + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string page_token = 3;</code> - - - - + type="string"/> - - deleteProduct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteProduct() + + setPageToken + \Google\Cloud\Vision\V1\ListProductsRequest::setPageToken() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - name + + var string - - optionalArgs - [] - array - - - - Permanently deletes a product and its reference images. - Metadata of the product and all its images will be deleted right away, but -search queries against ProductSets containing the product may still work -until all related caches are refreshed. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $productSearchClient->deleteProduct($formattedName); -} finally { - $productSearchClient->close(); -} -``` + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string page_token = 3;</code> - + description="" + variable="var" type="string"/> + name="return" + description="" + type="$this"/> - - deleteProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteProductSet() - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - name + + + + + + + + + + + + + + + + + + + + + + + + ListProductsResponse + \Google\Cloud\Vision\V1\ListProductsResponse + + Response message for the `ListProducts` method. + Generated from protobuf message <code>google.cloud.vision.v1.ListProductsResponse</code> + + + + \Google\Protobuf\Internal\Message + + + + products + \Google\Cloud\Vision\V1\ListProductsResponse::$products - string - + + List of products. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> + - - optionalArgs - [] + + + + next_page_token + \Google\Cloud\Vision\V1\ListProductsResponse::$next_page_token + '' + + Token to retrieve the next page of results, or empty if there are no more +results in the list. + Generated from protobuf field <code>string next_page_token = 2;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\ListProductsResponse::__construct() + + + data + null array - - Permanently deletes a ProductSet. Products and ReferenceImages in the -ProductSet are not deleted. - The actual image files are not deleted from Google Cloud Storage. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $productSearchClient->deleteProductSet($formattedName); -} finally { - $productSearchClient->close(); -} -``` + + Constructor. + - - + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\Product[] $products List of products. @type string $next_page_token Token to retrieve the next page of results, or empty if there are no more results in the list. }" + variable="data" type="array"/> - - deleteReferenceImage - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::deleteReferenceImage() + + getProducts + \Google\Cloud\Vision\V1\ListProductsResponse::getProducts() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - name - - string - - - - optionalArgs - [] - array - - - - Permanently deletes a reference image. - The image metadata will be deleted right away, but search queries -against ProductSets containing the image may still work until all related -caches are refreshed. - -The actual image files are not deleted from Google Cloud Storage. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->referenceImageName('[PROJECT]', '[LOCATION]', '[PRODUCT]', '[REFERENCE_IMAGE]'); - $productSearchClient->deleteReferenceImage($formattedName); -} finally { - $productSearchClient->close(); -} -``` + + List of products. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> - - + name="return" + description="" + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Product>"/> - - getProduct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProduct() + + setProducts + \Google\Cloud\Vision\V1\ListProductsResponse::setProducts() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - name + + var - string - - - - optionalArgs - [] - array + \Google\Cloud\Vision\V1\Product[] - - Gets information associated with a Product. - Possible errors: - -* Returns NOT_FOUND if the Product does not exist. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $response = $productSearchClient->getProduct($formattedName); -} finally { - $productSearchClient->close(); -} -``` + + List of products. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product products = 1;</code> - + description="" + variable="var" type="\Google\Cloud\Vision\V1\Product[]"/> - + type="$this"/> - - getProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getProductSet() + + getNextPageToken + \Google\Cloud\Vision\V1\ListProductsResponse::getNextPageToken() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - name - - string - - - - optionalArgs - [] - array - - - - Gets information associated with a ProductSet. - Possible errors: - -* Returns NOT_FOUND if the ProductSet does not exist. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $response = $productSearchClient->getProductSet($formattedName); -} finally { - $productSearchClient->close(); -} -``` + + Token to retrieve the next page of results, or empty if there are no more +results in the list. + Generated from protobuf field <code>string next_page_token = 2;</code> - - - + type="string"/> - - getReferenceImage - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::getReferenceImage() + + setNextPageToken + \Google\Cloud\Vision\V1\ListProductsResponse::setNextPageToken() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - name + + var string - - optionalArgs - [] - array - - - - Gets information associated with a ReferenceImage. - Possible errors: - -* Returns NOT_FOUND if the specified image does not exist. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->referenceImageName('[PROJECT]', '[LOCATION]', '[PRODUCT]', '[REFERENCE_IMAGE]'); - $response = $productSearchClient->getReferenceImage($formattedName); -} finally { - $productSearchClient->close(); -} -``` + + Token to retrieve the next page of results, or empty if there are no more +results in the list. + Generated from protobuf field <code>string next_page_token = 2;</code> - + description="" + variable="var" type="string"/> - + type="$this"/> - - importProductSets - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::importProductSets() - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - parent - - string - - - - inputConfig - - \Google\Cloud\Vision\V1\ImportProductSetsInputConfig - - - - optionalArgs - [] - array - + + + + + + + + + + + + - - Asynchronous API that imports a list of reference images to specified -product sets based on a list of image information. - The [google.longrunning.Operation][google.longrunning.Operation] API can be -used to keep track of the progress and results of the request. -`Operation.metadata` contains `BatchOperationMetadata`. (progress) -`Operation.response` contains `ImportProductSetsResponse`. (results) -The input source of this method is a csv file on Google Cloud Storage. -For the format of the csv file please see -[ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri]. + + + -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - $inputConfig = new ImportProductSetsInputConfig(); - $operationResponse = $productSearchClient->importProductSets($formattedParent, $inputConfig); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - $result = $operationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $productSearchClient->importProductSets($formattedParent, $inputConfig); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $productSearchClient->resumeOperation($operationName, 'importProductSets'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - $result = $newOperationResponse->getResult(); - // doSomethingWith($result) - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } -} finally { - $productSearchClient->close(); -} -``` - - - - - + + + + + + ListReferenceImagesRequest + \Google\Cloud\Vision\V1\ListReferenceImagesRequest + + Request message for the `ListReferenceImages` method. + Generated from protobuf message <code>google.cloud.vision.v1.ListReferenceImagesRequest</code> + - - - - listProductSets - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProductSets() - - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + \Google\Protobuf\Internal\Message + + + parent - - string - + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::$parent + '' + + Required. Resource name of the product containing the reference images. + Format is +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - - optionalArgs - [] - array - +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + page_size + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::$page_size + 0 + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> + - - Lists ProductSets in an unspecified order. - Possible errors: + -* Returns INVALID_ARGUMENT if page_size is greater than 100, or less -than 1. + + page_token + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::$page_token + '' + + A token identifying a page of results to be returned. This is the value +of `nextPageToken` returned in a previous reference image list request. + Defaults to the first page if not specified. -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - // Iterate over pages of elements - $pagedResponse = $productSearchClient->listProductSets($formattedParent); - foreach ($pagedResponse->iteratePages() as $page) { - foreach ($page as $element) { - // doSomethingWith($element); - } - } - // Alternatively: - // Iterate through all elements - $pagedResponse = $productSearchClient->listProductSets($formattedParent); - foreach ($pagedResponse->iterateAllElements() as $element) { - // doSomethingWith($element); - } -} finally { - $productSearchClient->close(); -} -``` - - - - - +Generated from protobuf field <code>string page_token = 3;</code> + - + - - listProducts - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProducts() + + + build + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::build() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient + parent string - - optionalArgs - [] - array - - - - Lists products in an unspecified order. - Possible errors: - -* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - // Iterate over pages of elements - $pagedResponse = $productSearchClient->listProducts($formattedParent); - foreach ($pagedResponse->iteratePages() as $page) { - foreach ($page as $element) { - // doSomethingWith($element); - } - } - // Alternatively: - // Iterate through all elements - $pagedResponse = $productSearchClient->listProducts($formattedParent); - foreach ($pagedResponse->iterateAllElements() as $element) { - // doSomethingWith($element); - } -} finally { - $productSearchClient->close(); -} -``` - - + + + + description="Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. Please see {@see \Google\Cloud\Vision\V1\ProductSearchClient::productName()} for help formatting this field." + variable="parent" type="string"/> + type="\Google\Cloud\Vision\V1\ListReferenceImagesRequest"/> + name="experimental" + description="" + /> - - listProductsInProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listProductsInProductSet() + + __construct + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::__construct() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - name - - string - - - - optionalArgs - [] + + data + null array - - Lists the Products in a ProductSet, in an unspecified order. If the -ProductSet does not exist, the products field of the response will be -empty. - Possible errors: - -* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - // Iterate over pages of elements - $pagedResponse = $productSearchClient->listProductsInProductSet($formattedName); - foreach ($pagedResponse->iteratePages() as $page) { - foreach ($page as $element) { - // doSomethingWith($element); - } - } - // Alternatively: - // Iterate through all elements - $pagedResponse = $productSearchClient->listProductsInProductSet($formattedName); - foreach ($pagedResponse->iterateAllElements() as $element) { - // doSomethingWith($element); - } -} finally { - $productSearchClient->close(); -} -``` - - + Constructor. + + - - + description="{ Optional. Data for populating the Message object. @type string $parent Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. @type int $page_size The maximum number of items to return. Default 10, maximum 100. @type string $page_token A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. }" + variable="data" type="array"/> - - listReferenceImages - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::listReferenceImages() + + getParent + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::getParent() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - parent - - string - - - - optionalArgs - [] - array - - - - Lists reference images. - Possible errors: - -* Returns NOT_FOUND if the parent product does not exist. -* Returns INVALID_ARGUMENT if the page_size is greater than 100, or less -than 1. + + Required. Resource name of the product containing the reference images. + Format is +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - // Iterate over pages of elements - $pagedResponse = $productSearchClient->listReferenceImages($formattedParent); - foreach ($pagedResponse->iteratePages() as $page) { - foreach ($page as $element) { - // doSomethingWith($element); - } - } - // Alternatively: - // Iterate through all elements - $pagedResponse = $productSearchClient->listReferenceImages($formattedParent); - foreach ($pagedResponse->iterateAllElements() as $element) { - // doSomethingWith($element); - } -} finally { - $productSearchClient->close(); -} -``` - - - + - + type="string"/> - - purgeProducts - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::purgeProducts() + + setParent + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::setParent() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - parent + + var string - - optionalArgs - [] - array - - - - Asynchronous API to delete all Products in a ProductSet or all Products -that are in no ProductSet. - If a Product is a member of the specified ProductSet in addition to other -ProductSets, the Product will still be deleted. - -It is recommended to not delete the specified ProductSet until after this -operation has completed. It is also recommended to not add any of the -Products involved in the batch delete to a new ProductSet while this -operation is running because those Products may still end up deleted. - -It's not possible to undo the PurgeProducts operation. Therefore, it is -recommended to keep the csv files used in ImportProductSets (if that was -how you originally built the Product Set) before starting PurgeProducts, in -case you need to re-import the data after deletion. - -If the plan is to purge all of the Products from a ProductSet and then -re-use the empty ProductSet to re-import new Products into the empty -ProductSet, you must wait until the PurgeProducts operation has finished -for that ProductSet. - -The [google.longrunning.Operation][google.longrunning.Operation] API can be -used to keep track of the progress and results of the request. -`Operation.metadata` contains `BatchOperationMetadata`. (progress) + + Required. Resource name of the product containing the reference images. + Format is +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedParent = $productSearchClient->locationName('[PROJECT]', '[LOCATION]'); - $operationResponse = $productSearchClient->purgeProducts($formattedParent); - $operationResponse->pollUntilComplete(); - if ($operationResponse->operationSucceeded()) { - // operation succeeded and returns no value - } else { - $error = $operationResponse->getError(); - // handleError($error) - } - // Alternatively: - // start the operation, keep the operation name, and resume later - $operationResponse = $productSearchClient->purgeProducts($formattedParent); - $operationName = $operationResponse->getName(); - // ... do other work - $newOperationResponse = $productSearchClient->resumeOperation($operationName, 'purgeProducts'); - while (!$newOperationResponse->isDone()) { - // ... do other work - $newOperationResponse->reload(); - } - if ($newOperationResponse->operationSucceeded()) { - // operation succeeded and returns no value - } else { - $error = $newOperationResponse->getError(); - // handleError($error) - } -} finally { - $productSearchClient->close(); -} -``` - - + + description="" + variable="var" type="string"/> - + type="$this"/> - - removeProductFromProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::removeProductFromProductSet() + + getPageSize + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::getPageSize() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - name - - string - - - - product - - string - - - - optionalArgs - [] - array - - - - Removes a Product from the specified ProductSet. - Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $formattedName = $productSearchClient->productSetName('[PROJECT]', '[LOCATION]', '[PRODUCT_SET]'); - $formattedProduct = $productSearchClient->productName('[PROJECT]', '[LOCATION]', '[PRODUCT]'); - $productSearchClient->removeProductFromProductSet($formattedName, $formattedProduct); -} finally { - $productSearchClient->close(); -} -``` - - - - + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> + - - updateProduct - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::updateProduct() + + setPageSize + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::setPageSize() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - product + + var - \Google\Cloud\Vision\V1\Product - - - - optionalArgs - [] - array + int - - Makes changes to a Product resource. - Only the `display_name`, `description`, and `labels` fields can be updated -right now. - -If labels are updated, the change will not be reflected in queries until -the next index time. - -Possible errors: - -* Returns NOT_FOUND if the Product does not exist. -* Returns INVALID_ARGUMENT if display_name is present in update_mask but is -missing from the request or longer than 4096 characters. -* Returns INVALID_ARGUMENT if description is present in update_mask but is -longer than 4096 characters. -* Returns INVALID_ARGUMENT if product_category is present in update_mask. - -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $product = new Product(); - $response = $productSearchClient->updateProduct($product); -} finally { - $productSearchClient->close(); -} -``` + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> - + description="" + variable="var" type="int"/> - + type="$this"/> - - updateProductSet - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient::updateProductSet() + + getPageToken + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::getPageToken() - \Google\Cloud\Vision\V1\Gapic\ProductSearchGapicClient - productSet - - \Google\Cloud\Vision\V1\ProductSet - + + A token identifying a page of results to be returned. This is the value +of `nextPageToken` returned in a previous reference image list request. + Defaults to the first page if not specified. - - optionalArgs - [] - array - +Generated from protobuf field <code>string page_token = 3;</code> + + - - Makes changes to a ProductSet resource. - Only display_name can be updated currently. + -Possible errors: + + setPageToken + \Google\Cloud\Vision\V1\ListReferenceImagesRequest::setPageToken() + + + var + + string + -* Returns NOT_FOUND if the ProductSet does not exist. -* Returns INVALID_ARGUMENT if display_name is present in update_mask but -missing from the request or longer than 4096 characters. + + A token identifying a page of results to be returned. This is the value +of `nextPageToken` returned in a previous reference image list request. + Defaults to the first page if not specified. -Sample code: -``` -$productSearchClient = new ProductSearchClient(); -try { - $productSet = new ProductSet(); - $response = $productSearchClient->updateProductSet($productSet); -} finally { - $productSearchClient->close(); -} -``` +Generated from protobuf field <code>string page_token = 3;</code> - + description="" + variable="var" type="string"/> - + type="$this"/> - + - + @@ -32014,1028 +17969,673 @@ try { - - ProductSearchGrpcClient - \Google\Cloud\Vision\V1\ProductSearchGrpcClient - - Manages Products and ProductSets of reference images for use in product -search. It uses the following resource model: - - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet] resources, named -`projects/&#42;/locations/&#42;/productSets/*`, which acts as a way to put different -products into groups to limit identification. - -In parallel, - -- The API has a collection of [Product][google.cloud.vision.v1.Product] resources, named - `projects/&#42;/locations/&#42;/products/*` - -- Each [Product][google.cloud.vision.v1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named - `projects/&#42;/locations/&#42;/products/&#42;/referenceImages/*` + + + ListReferenceImagesResponse + \Google\Cloud\Vision\V1\ListReferenceImagesResponse + + Response message for the `ListReferenceImages` method. + Generated from protobuf message <code>google.cloud.vision.v1.ListReferenceImagesResponse</code> - \Grpc\BaseStub + \Google\Protobuf\Internal\Message - - - __construct - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::__construct() - - - hostname - - string - - - - opts - - array - - - - channel - null - \Grpc\Channel - - - - - - - - - - - - - - CreateProductSet - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::CreateProductSet() - - - argument - - \Google\Cloud\Vision\V1\CreateProductSetRequest - - - - metadata - [] - array - - - - options - [] - array - - - - Creates and returns a new ProductSet resource. - Possible errors: - -* Returns INVALID_ARGUMENT if display_name is missing, or is longer than - 4096 characters. - - - - - - - - - - ListProductSets - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::ListProductSets() - - - argument + + reference_images + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::$reference_images - \Google\Cloud\Vision\V1\ListProductSetsRequest - + + The list of reference images. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> + - - metadata - [] - array - + - - options - [] - array - + + page_size + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::$page_size + 0 + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> + - - Lists ProductSets in an unspecified order. - Possible errors: + -* Returns INVALID_ARGUMENT if page_size is greater than 100, or less - than 1. - - - - - + + next_page_token + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::$next_page_token + '' + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string next_page_token = 3;</code> + - + - - GetProductSet - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::GetProductSet() + + + __construct + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::__construct() - - argument - - \Google\Cloud\Vision\V1\GetProductSetRequest - - - - metadata - [] - array - - - - options - [] + + data + null array - - Gets information associated with a ProductSet. - Possible errors: - -* Returns NOT_FOUND if the ProductSet does not exist. + + Constructor. + - - - + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\ReferenceImage[] $reference_images The list of reference images. @type int $page_size The maximum number of items to return. Default 10, maximum 100. @type string $next_page_token The next_page_token returned from a previous List request, if any. }" + variable="data" type="array"/> - - UpdateProductSet - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::UpdateProductSet() - - - argument - - \Google\Cloud\Vision\V1\UpdateProductSetRequest - - - - metadata - [] - array - - - - options - [] - array - - - - Makes changes to a ProductSet resource. - Only display_name can be updated currently. - -Possible errors: - -* Returns NOT_FOUND if the ProductSet does not exist. -* Returns INVALID_ARGUMENT if display_name is present in update_mask but - missing from the request or longer than 4096 characters. - - - - + getReferenceImages + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::getReferenceImages() + + + The list of reference images. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> + + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\ReferenceImage>"/> - - DeleteProductSet - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::DeleteProductSet() + + setReferenceImages + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::setReferenceImages() - - argument + + var - \Google\Cloud\Vision\V1\DeleteProductSetRequest - - - - metadata - [] - array - - - - options - [] - array + \Google\Cloud\Vision\V1\ReferenceImage[] - - Permanently deletes a ProductSet. Products and ReferenceImages in the -ProductSet are not deleted. - The actual image files are not deleted from Google Cloud Storage. + + The list of reference images. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ReferenceImage reference_images = 1;</code> - - + description="" + variable="var" type="\Google\Cloud\Vision\V1\ReferenceImage[]"/> + type="$this"/> - - CreateProduct - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::CreateProduct() + + getPageSize + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::getPageSize() - - argument - - \Google\Cloud\Vision\V1\CreateProductRequest - + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> + + - - metadata - [] - array - + - - options - [] - array + + setPageSize + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::setPageSize() + + + var + + int - - Creates and returns a new product resource. - Possible errors: - -* Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 - characters. -* Returns INVALID_ARGUMENT if description is longer than 4096 characters. -* Returns INVALID_ARGUMENT if product_category is missing or invalid. + + The maximum number of items to return. Default 10, maximum 100. + Generated from protobuf field <code>int32 page_size = 2;</code> - - + description="" + variable="var" type="int"/> + type="$this"/> - - ListProducts - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::ListProducts() + + getNextPageToken + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::getNextPageToken() - - argument - - \Google\Cloud\Vision\V1\ListProductsRequest - + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string next_page_token = 3;</code> + + - - metadata - [] - array - + - - options - [] - array + + setNextPageToken + \Google\Cloud\Vision\V1\ListReferenceImagesResponse::setNextPageToken() + + + var + + string - - Lists products in an unspecified order. - Possible errors: - -* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + + The next_page_token returned from a previous List request, if any. + Generated from protobuf field <code>string next_page_token = 3;</code> - - + description="" + variable="var" type="string"/> + type="$this"/> - - GetProduct - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::GetProduct() - - - argument - - \Google\Cloud\Vision\V1\GetProductRequest - + + + + + + + + + + + + - - metadata - [] - array - - - options - [] + + + + + + + + + + LocalizedObjectAnnotation + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation + + Set of detected objects with bounding boxes. + Generated from protobuf message <code>google.cloud.vision.v1.LocalizedObjectAnnotation</code> + + + + \Google\Protobuf\Internal\Message + + + + mid + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$mid + '' + + Object ID that should align with EntityAnnotation mid. + Generated from protobuf field <code>string mid = 1;</code> + + + + + + language_code + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$language_code + '' + + The BCP-47 language code, such as "en-US" or "sr-Latn". For more +information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + Generated from protobuf field <code>string language_code = 2;</code> + + + + + + name + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$name + '' + + Object name, expressed in its `language_code` language. + Generated from protobuf field <code>string name = 3;</code> + + + + + + score + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$score + 0.0 + + Score of the result. Range [0, 1]. + Generated from protobuf field <code>float score = 4;</code> + + + + + + bounding_poly + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::$bounding_poly + null + + Image region to which this object belongs. This must be populated. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 5;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::__construct() + + + data + null array - - Gets information associated with a Product. - Possible errors: - -* Returns NOT_FOUND if the Product does not exist. + + Constructor. + - - - + + + + + + getMid + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getMid() + + + Object ID that should align with EntityAnnotation mid. + Generated from protobuf field <code>string mid = 1;</code> + + type="string"/> - - UpdateProduct - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::UpdateProduct() + + setMid + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setMid() - - argument + + var - \Google\Cloud\Vision\V1\UpdateProductRequest - - - - metadata - [] - array - - - - options - [] - array + string - - Makes changes to a Product resource. - Only the `display_name`, `description`, and `labels` fields can be updated -right now. - -If labels are updated, the change will not be reflected in queries until -the next index time. - -Possible errors: - -* Returns NOT_FOUND if the Product does not exist. -* Returns INVALID_ARGUMENT if display_name is present in update_mask but is - missing from the request or longer than 4096 characters. -* Returns INVALID_ARGUMENT if description is present in update_mask but is - longer than 4096 characters. -* Returns INVALID_ARGUMENT if product_category is present in update_mask. + + Object ID that should align with EntityAnnotation mid. + Generated from protobuf field <code>string mid = 1;</code> - - + description="" + variable="var" type="string"/> + type="$this"/> - - DeleteProduct - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::DeleteProduct() + + getLanguageCode + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getLanguageCode() - - argument - - \Google\Cloud\Vision\V1\DeleteProductRequest - - - - metadata - [] - array - - - - options - [] - array - - - - Permanently deletes a product and its reference images. - Metadata of the product and all its images will be deleted right away, but -search queries against ProductSets containing the product may still work -until all related caches are refreshed. + + The BCP-47 language code, such as "en-US" or "sr-Latn". For more +information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + Generated from protobuf field <code>string language_code = 2;</code> - - - + type="string"/> - - CreateReferenceImage - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::CreateReferenceImage() + + setLanguageCode + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setLanguageCode() - - argument + + var - \Google\Cloud\Vision\V1\CreateReferenceImageRequest - - - - metadata - [] - array - - - - options - [] - array + string - - Creates and returns a new ReferenceImage resource. - The `bounding_poly` field is optional. If `bounding_poly` is not specified, -the system will try to detect regions of interest in the image that are -compatible with the product_category on the parent product. If it is -specified, detection is ALWAYS skipped. The system converts polygons into -non-rotated rectangles. - -Note that the pipeline will resize the image if the image resolution is too -large to process (above 50MP). - -Possible errors: - -* Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 - characters. -* Returns INVALID_ARGUMENT if the product does not exist. -* Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing - compatible with the parent product's product_category is detected. -* Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. + + The BCP-47 language code, such as "en-US" or "sr-Latn". For more +information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + Generated from protobuf field <code>string language_code = 2;</code> - - + description="" + variable="var" type="string"/> + type="$this"/> - - DeleteReferenceImage - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::DeleteReferenceImage() + + getName + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getName() - - argument - - \Google\Cloud\Vision\V1\DeleteReferenceImageRequest - - - - metadata - [] - array - - - - options - [] - array - - - - Permanently deletes a reference image. - The image metadata will be deleted right away, but search queries -against ProductSets containing the image may still work until all related -caches are refreshed. - -The actual image files are not deleted from Google Cloud Storage. + + Object name, expressed in its `language_code` language. + Generated from protobuf field <code>string name = 3;</code> - - - + type="string"/> - - ListReferenceImages - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::ListReferenceImages() + + setName + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setName() - - argument + + var - \Google\Cloud\Vision\V1\ListReferenceImagesRequest - - - - metadata - [] - array - - - - options - [] - array + string - - Lists reference images. - Possible errors: - -* Returns NOT_FOUND if the parent product does not exist. -* Returns INVALID_ARGUMENT if the page_size is greater than 100, or less - than 1. + + Object name, expressed in its `language_code` language. + Generated from protobuf field <code>string name = 3;</code> - - + description="" + variable="var" type="string"/> + type="$this"/> - - GetReferenceImage - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::GetReferenceImage() + + getScore + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getScore() - - argument - - \Google\Cloud\Vision\V1\GetReferenceImageRequest - + + Score of the result. Range [0, 1]. + Generated from protobuf field <code>float score = 4;</code> + + - - metadata - [] - array - + - - options - [] - array + + setScore + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setScore() + + + var + + float - - Gets information associated with a ReferenceImage. - Possible errors: - -* Returns NOT_FOUND if the specified image does not exist. + + Score of the result. Range [0, 1]. + Generated from protobuf field <code>float score = 4;</code> - - + description="" + variable="var" type="float"/> + type="$this"/> - - AddProductToProductSet - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::AddProductToProductSet() + + getBoundingPoly + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::getBoundingPoly() - - argument - - \Google\Cloud\Vision\V1\AddProductToProductSetRequest - - - - metadata - [] - array - - - - options - [] - array - - - - Adds a Product to the specified ProductSet. If the Product is already -present, no change is made. - One Product can be added to at most 100 ProductSets. - -Possible errors: - -* Returns NOT_FOUND if the Product or the ProductSet doesn't exist. + + Image region to which this object belongs. This must be populated. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 5;</code> - - - + type="\Google\Cloud\Vision\V1\BoundingPoly|null"/> - - RemoveProductFromProductSet - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::RemoveProductFromProductSet() + + hasBoundingPoly + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::hasBoundingPoly() - - argument - - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest - + + + + - - metadata - [] - array - + - - options - [] - array + + clearBoundingPoly + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::clearBoundingPoly() + + + + + + + + + + setBoundingPoly + \Google\Cloud\Vision\V1\LocalizedObjectAnnotation::setBoundingPoly() + + + var + + \Google\Cloud\Vision\V1\BoundingPoly - - Removes a Product from the specified ProductSet. - + + Image region to which this object belongs. This must be populated. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 5;</code> - - + description="" + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> + type="$this"/> - - ListProductsInProductSet - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::ListProductsInProductSet() - - - argument - - \Google\Cloud\Vision\V1\ListProductsInProductSetRequest - - - - metadata - [] - array - + + + + + + + + + + + + - - options - [] - array - - - Lists the Products in a ProductSet, in an unspecified order. If the -ProductSet does not exist, the products field of the response will be -empty. - Possible errors: + + + -* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + + + + + + LocationInfo + \Google\Cloud\Vision\V1\LocationInfo + + Detected entity location information. + Generated from protobuf message <code>google.cloud.vision.v1.LocationInfo</code> - - - + name="package" + description="Application" + /> - + \Google\Protobuf\Internal\Message + + + + lat_lng + \Google\Cloud\Vision\V1\LocationInfo::$lat_lng + null + + lat/long location coordinates. + Generated from protobuf field <code>.google.type.LatLng lat_lng = 1;</code> + - - ImportProductSets - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::ImportProductSets() - - - argument - - \Google\Cloud\Vision\V1\ImportProductSetsRequest - + - - metadata - [] + + + __construct + \Google\Cloud\Vision\V1\LocationInfo::__construct() + + + data + null array - - options - [] - array - + + Constructor. + + + - - Asynchronous API that imports a list of reference images to specified -product sets based on a list of image information. - The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the -progress and results of the request. -`Operation.metadata` contains `BatchOperationMetadata`. (progress) -`Operation.response` contains `ImportProductSetsResponse`. (results) + -The input source of this method is a csv file on Google Cloud Storage. -For the format of the csv file please see -[ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri]. + + getLatLng + \Google\Cloud\Vision\V1\LocationInfo::getLatLng() + + + lat/long location coordinates. + Generated from protobuf field <code>.google.type.LatLng lat_lng = 1;</code> - - - + type="\Google\Type\LatLng|null"/> - - PurgeProducts - \Google\Cloud\Vision\V1\ProductSearchGrpcClient::PurgeProducts() + + hasLatLng + \Google\Cloud\Vision\V1\LocationInfo::hasLatLng() - - argument - - \Google\Cloud\Vision\V1\PurgeProductsRequest - - - - metadata - [] - array - - - - options - [] - array - + + + + - - Asynchronous API to delete all Products in a ProductSet or all Products -that are in no ProductSet. - If a Product is a member of the specified ProductSet in addition to other -ProductSets, the Product will still be deleted. + -It is recommended to not delete the specified ProductSet until after this -operation has completed. It is also recommended to not add any of the -Products involved in the batch delete to a new ProductSet while this -operation is running because those Products may still end up deleted. + + clearLatLng + \Google\Cloud\Vision\V1\LocationInfo::clearLatLng() + + + + + -It's not possible to undo the PurgeProducts operation. Therefore, it is -recommended to keep the csv files used in ImportProductSets (if that was -how you originally built the Product Set) before starting PurgeProducts, in -case you need to re-import the data after deletion. + -If the plan is to purge all of the Products from a ProductSet and then -re-use the empty ProductSet to re-import new Products into the empty -ProductSet, you must wait until the PurgeProducts operation has finished -for that ProductSet. + + setLatLng + \Google\Cloud\Vision\V1\LocationInfo::setLatLng() + + + var + + \Google\Type\LatLng + -The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the -progress and results of the request. -`Operation.metadata` contains `BatchOperationMetadata`. (progress) + + lat/long location coordinates. + Generated from protobuf field <code>.google.type.LatLng lat_lng = 1;</code> - - + description="" + variable="var" type="\Google\Type\LatLng"/> + type="$this"/> @@ -33046,7 +18646,7 @@ progress and results of the request. - + @@ -33061,15 +18661,19 @@ progress and results of the request. - - - - - ProductSearchParams - \Google\Cloud\Vision\V1\ProductSearchParams - - Parameters for a product search request. - Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchParams</code> + + + + + + NormalizedVertex + \Google\Cloud\Vision\V1\NormalizedVertex + + A vertex represents a 2D point in the image. + NOTE: the normalized vertex coordinates are relative to the original image +and range from 0 to 1. + +Generated from protobuf message <code>google.cloud.vision.v1.NormalizedVertex</code> \Google\Protobuf\Internal\Message - - bounding_poly - \Google\Cloud\Vision\V1\ProductSearchParams::$bounding_poly - null - - The bounding polygon around the area of interest in the image. - If it is not specified, system discretion will be applied. - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 9;</code> - - - - - - product_set - \Google\Cloud\Vision\V1\ProductSearchParams::$product_set - '' - - The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to -be searched for similar images. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. - -Generated from protobuf field <code>string product_set = 6 [(.google.api.resource_reference) = {</code> - - - - - - product_categories - \Google\Cloud\Vision\V1\ProductSearchParams::$product_categories - - - The list of product categories to search in. Currently, we only consider -the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", -"packagedgoods-v1", or "general-v1" should be specified. The legacy -categories "homegoods", "apparel", and "toys" are still supported but will -be deprecated. For new products, please use "homegoods-v2", "apparel-v2", -or "toys-v2" for better product search accuracy. It is recommended to -migrate existing products to these categories as well. - Generated from protobuf field <code>repeated string product_categories = 7;</code> + + x + \Google\Cloud\Vision\V1\NormalizedVertex::$x + 0.0 + + X coordinate. + Generated from protobuf field <code>float x = 1;</code> - - filter - \Google\Cloud\Vision\V1\ProductSearchParams::$filter - '' - - The filtering expression. This can be used to restrict search results based -on Product labels. We currently support an AND of OR of key-value -expressions, where each expression within an OR must have the same key. An -'=' should be used to connect the key and value. - For example, "(color = red OR color = blue) AND brand = Google" is -acceptable, but "(color = red OR brand = Google)" is not acceptable. -"color: red" is not acceptable because it uses a ':' instead of an '='. - -Generated from protobuf field <code>string filter = 8;</code> + + y + \Google\Cloud\Vision\V1\NormalizedVertex::$y + 0.0 + + Y coordinate. + Generated from protobuf field <code>float y = 2;</code> - + __construct - \Google\Cloud\Vision\V1\ProductSearchParams::__construct() + \Google\Cloud\Vision\V1\NormalizedVertex::__construct() - + data - NULL + null array - + Constructor. - - getBoundingPoly - \Google\Cloud\Vision\V1\ProductSearchParams::getBoundingPoly() + + getX + \Google\Cloud\Vision\V1\NormalizedVertex::getX() - - The bounding polygon around the area of interest in the image. - If it is not specified, system discretion will be applied. - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 9;</code> + + X coordinate. + Generated from protobuf field <code>float x = 1;</code> + type="float"/> - - hasBoundingPoly - \Google\Cloud\Vision\V1\ProductSearchParams::hasBoundingPoly() - - - - - - - - - - clearBoundingPoly - \Google\Cloud\Vision\V1\ProductSearchParams::clearBoundingPoly() - - - - - - - - - - setBoundingPoly - \Google\Cloud\Vision\V1\ProductSearchParams::setBoundingPoly() + + setX + \Google\Cloud\Vision\V1\NormalizedVertex::setX() - + var - \Google\Cloud\Vision\V1\BoundingPoly + float - - The bounding polygon around the area of interest in the image. - If it is not specified, system discretion will be applied. - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 9;</code> + + X coordinate. + Generated from protobuf field <code>float x = 1;</code> + variable="var" type="float"/> - - getProductSet - \Google\Cloud\Vision\V1\ProductSearchParams::getProductSet() + + getY + \Google\Cloud\Vision\V1\NormalizedVertex::getY() - - The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to -be searched for similar images. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. - -Generated from protobuf field <code>string product_set = 6 [(.google.api.resource_reference) = {</code> + + Y coordinate. + Generated from protobuf field <code>float y = 2;</code> + type="float"/> - - setProductSet - \Google\Cloud\Vision\V1\ProductSearchParams::setProductSet() + + setY + \Google\Cloud\Vision\V1\NormalizedVertex::setY() - + var - string + float - - The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to -be searched for similar images. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. - -Generated from protobuf field <code>string product_set = 6 [(.google.api.resource_reference) = {</code> + + Y coordinate. + Generated from protobuf field <code>float y = 2;</code> + variable="var" type="float"/> - - getProductCategories - \Google\Cloud\Vision\V1\ProductSearchParams::getProductCategories() - - - The list of product categories to search in. Currently, we only consider -the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", -"packagedgoods-v1", or "general-v1" should be specified. The legacy -categories "homegoods", "apparel", and "toys" are still supported but will -be deprecated. For new products, please use "homegoods-v2", "apparel-v2", -or "toys-v2" for better product search accuracy. It is recommended to -migrate existing products to these categories as well. - Generated from protobuf field <code>repeated string product_categories = 7;</code> - - + + + + + + + + + + + + + + + + + + + + + + + + State + \Google\Cloud\Vision\V1\OperationMetadata\State + + Batch operation states. + Protobuf type <code>google.cloud.vision.v1.OperationMetadata.State</code> + + + + + + + STATE_UNSPECIFIED + \Google\Cloud\Vision\V1\OperationMetadata\State::STATE_UNSPECIFIED + 0 + + Invalid. + Generated from protobuf enum <code>STATE_UNSPECIFIED = 0;</code> + + + + + + CREATED + \Google\Cloud\Vision\V1\OperationMetadata\State::CREATED + 1 + + Request is received. + Generated from protobuf enum <code>CREATED = 1;</code> + + + + + + RUNNING + \Google\Cloud\Vision\V1\OperationMetadata\State::RUNNING + 2 + + Request is actively being processed. + Generated from protobuf enum <code>RUNNING = 2;</code> + + + + + + DONE + \Google\Cloud\Vision\V1\OperationMetadata\State::DONE + 3 + + The batch processing is done. + Generated from protobuf enum <code>DONE = 3;</code> + + + - + + CANCELLED + \Google\Cloud\Vision\V1\OperationMetadata\State::CANCELLED + 4 + + The batch processing was cancelled. + Generated from protobuf enum <code>CANCELLED = 4;</code> + - - setProductCategories - \Google\Cloud\Vision\V1\ProductSearchParams::setProductCategories() - - - var - - string[]|\Google\Protobuf\Internal\RepeatedField - + - - The list of product categories to search in. Currently, we only consider -the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", -"packagedgoods-v1", or "general-v1" should be specified. The legacy -categories "homegoods", "apparel", and "toys" are still supported but will -be deprecated. For new products, please use "homegoods-v2", "apparel-v2", -or "toys-v2" for better product search accuracy. It is recommended to -migrate existing products to these categories as well. - Generated from protobuf field <code>repeated string product_categories = 7;</code> - - - + + + valueToName + \Google\Cloud\Vision\V1\OperationMetadata\State::$valueToName + [self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', self::CREATED => 'CREATED', self::RUNNING => 'RUNNING', self::DONE => 'DONE', self::CANCELLED => 'CANCELLED'] + + + + - + - - getFilter - \Google\Cloud\Vision\V1\ProductSearchParams::getFilter() + + + name + \Google\Cloud\Vision\V1\OperationMetadata\State::name() - - The filtering expression. This can be used to restrict search results based -on Product labels. We currently support an AND of OR of key-value -expressions, where each expression within an OR must have the same key. An -'=' should be used to connect the key and value. - For example, "(color = red OR color = blue) AND brand = Google" is -acceptable, but "(color = red OR brand = Google)" is not acceptable. -"color: red" is not acceptable because it uses a ':' instead of an '='. + + value + + mixed + -Generated from protobuf field <code>string filter = 8;</code> - - + + + + - - setFilter - \Google\Cloud\Vision\V1\ProductSearchParams::setFilter() + + value + \Google\Cloud\Vision\V1\OperationMetadata\State::value() - - var + + name - string + mixed - - The filtering expression. This can be used to restrict search results based -on Product labels. We currently support an AND of OR of key-value -expressions, where each expression within an OR must have the same key. An -'=' should be used to connect the key and value. - For example, "(color = red OR color = blue) AND brand = Google" is -acceptable, but "(color = red OR brand = Google)" is not acceptable. -"color: red" is not acceptable because it uses a ':' instead of an '='. - -Generated from protobuf field <code>string filter = 8;</code> - - - + + + + @@ -33390,7 +18954,7 @@ Generated from protobuf field <code>string filter = 8;</code> - + @@ -33402,19 +18966,19 @@ Generated from protobuf field <code>string filter = 8;</code> + - - GroupedResult - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult - - Information about the products similar to a single product in a query -image. - Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchResults.GroupedResult</code> + + + OperationMetadata + \Google\Cloud\Vision\V1\OperationMetadata + + Contains metadata for the BatchAnnotateImages operation. + Generated from protobuf message <code>google.cloud.vision.v1.OperationMetadata</code> \Google\Protobuf\Internal\Message - - bounding_poly - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::$bounding_poly - null - - The bounding polygon around the product detected in the query image. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + + state + \Google\Cloud\Vision\V1\OperationMetadata::$state + 0 + + Current state of the batch operation. + Generated from protobuf field <code>.google.cloud.vision.v1.OperationMetadata.State state = 1;</code> - - results - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::$results - - - List of results, one for each product match. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 2;</code> + + create_time + \Google\Cloud\Vision\V1\OperationMetadata::$create_time + null + + The time when the batch request was received. + Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 5;</code> - - object_annotations - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::$object_annotations - - - List of generic predictions for the object in the bounding box. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation object_annotations = 3;</code> + + update_time + \Google\Cloud\Vision\V1\OperationMetadata::$update_time + null + + The time when the operation result was last updated. + Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 6;</code> - + __construct - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::__construct() + \Google\Cloud\Vision\V1\OperationMetadata::__construct() - + data - NULL + null array - + Constructor. - - getBoundingPoly - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::getBoundingPoly() + + getState + \Google\Cloud\Vision\V1\OperationMetadata::getState() - - The bounding polygon around the product detected in the query image. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + + Current state of the batch operation. + Generated from protobuf field <code>.google.cloud.vision.v1.OperationMetadata.State state = 1;</code> + type="int"/> - - hasBoundingPoly - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::hasBoundingPoly() + + setState + \Google\Cloud\Vision\V1\OperationMetadata::setState() + + + var + + int + + + + Current state of the batch operation. + Generated from protobuf field <code>.google.cloud.vision.v1.OperationMetadata.State state = 1;</code> + + + + + + + + getCreateTime + \Google\Cloud\Vision\V1\OperationMetadata::getCreateTime() + + + The time when the batch request was received. + Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 5;</code> + + + + + + + hasCreateTime + \Google\Cloud\Vision\V1\OperationMetadata::hasCreateTime() - + - - clearBoundingPoly - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::clearBoundingPoly() + + clearCreateTime + \Google\Cloud\Vision\V1\OperationMetadata::clearCreateTime() - + - - setBoundingPoly - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::setBoundingPoly() + + setCreateTime + \Google\Cloud\Vision\V1\OperationMetadata::setCreateTime() - + var - \Google\Cloud\Vision\V1\BoundingPoly + \Google\Protobuf\Timestamp - - The bounding polygon around the product detected in the query image. - Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + + The time when the batch request was received. + Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 5;</code> + variable="var" type="\Google\Protobuf\Timestamp"/> - - getResults - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::getResults() + + getUpdateTime + \Google\Cloud\Vision\V1\OperationMetadata::getUpdateTime() - - List of results, one for each product match. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 2;</code> + + The time when the operation result was last updated. + Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 6;</code> + type="\Google\Protobuf\Timestamp|null"/> - - setResults - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::setResults() + + hasUpdateTime + \Google\Cloud\Vision\V1\OperationMetadata::hasUpdateTime() - - var - - \Google\Cloud\Vision\V1\ProductSearchResults\Result[]|\Google\Protobuf\Internal\RepeatedField - - - - List of results, one for each product match. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 2;</code> - - - + + + + - - getObjectAnnotations - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::getObjectAnnotations() + + clearUpdateTime + \Google\Cloud\Vision\V1\OperationMetadata::clearUpdateTime() - - List of generic predictions for the object in the bounding box. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation object_annotations = 3;</code> - - + + + + - - setObjectAnnotations - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::setObjectAnnotations() + + setUpdateTime + \Google\Cloud\Vision\V1\OperationMetadata::setUpdateTime() - + var - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation[]|\Google\Protobuf\Internal\RepeatedField + \Google\Protobuf\Timestamp - - List of generic predictions for the object in the bounding box. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation object_annotations = 3;</code> + + The time when the operation result was last updated. + Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 6;</code> + variable="var" type="\Google\Protobuf\Timestamp"/> - + @@ -33639,18 +19225,19 @@ image. - + - - ObjectAnnotation - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation + + + OutputConfig + \Google\Cloud\Vision\V1\OutputConfig - Prediction for what the object in the bounding box is. - Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation</code> + The desired output location and metadata. + Generated from protobuf message <code>google.cloud.vision.v1.OutputConfig</code> \Google\Protobuf\Internal\Message - - mid - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::$mid - '' + + gcs_destination + \Google\Cloud\Vision\V1\OutputConfig::$gcs_destination + null - Object ID that should align with EntityAnnotation mid. - Generated from protobuf field <code>string mid = 1;</code> - - - - - - language_code - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::$language_code - '' - - The BCP-47 language code, such as "en-US" or "sr-Latn". For more -information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - Generated from protobuf field <code>string language_code = 2;</code> + The Google Cloud Storage location to write the output(s) to. + Generated from protobuf field <code>.google.cloud.vision.v1.GcsDestination gcs_destination = 1;</code> - - name - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::$name - '' + + batch_size + \Google\Cloud\Vision\V1\OutputConfig::$batch_size + 0 - Object name, expressed in its `language_code` language. - Generated from protobuf field <code>string name = 3;</code> - - - + The max number of response protos to put into each output JSON file on +Google Cloud Storage. + The valid range is [1, 100]. If not specified, the default value is 20. +For example, for one pdf file with 100 pages, 100 response protos will +be generated. If `batch_size` = 20, then 5 json files each +containing 20 response protos will be written under the prefix +`gcs_destination`.`uri`. +Currently, batch_size only applies to GcsDestination, with potential future +support for other output configurations. - - score - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::$score - 0.0 - - Score of the result. Range [0, 1]. - Generated from protobuf field <code>float score = 4;</code> +Generated from protobuf field <code>int32 batch_size = 2;</code> - + __construct - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::__construct() + \Google\Cloud\Vision\V1\OutputConfig::__construct() - + data - NULL + null array - + Constructor. - - - - - - getMid - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::getMid() - - - Object ID that should align with EntityAnnotation mid. - Generated from protobuf field <code>string mid = 1;</code> - - - - - - - setMid - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::setMid() - - - var - - string - - - - Object ID that should align with EntityAnnotation mid. - Generated from protobuf field <code>string mid = 1;</code> - - - - - - - - getLanguageCode - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::getLanguageCode() - - - The BCP-47 language code, such as "en-US" or "sr-Latn". For more -information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - Generated from protobuf field <code>string language_code = 2;</code> - - - - - - - setLanguageCode - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::setLanguageCode() - - - var - - string - - - - The BCP-47 language code, such as "en-US" or "sr-Latn". For more -information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - Generated from protobuf field <code>string language_code = 2;</code> - - + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\GcsDestination $gcs_destination The Google Cloud Storage location to write the output(s) to. @type int $batch_size The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. }" + variable="data" type="array"/> - - getName - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::getName() + + getGcsDestination + \Google\Cloud\Vision\V1\OutputConfig::getGcsDestination() - - Object name, expressed in its `language_code` language. - Generated from protobuf field <code>string name = 3;</code> + + The Google Cloud Storage location to write the output(s) to. + Generated from protobuf field <code>.google.cloud.vision.v1.GcsDestination gcs_destination = 1;</code> + type="\Google\Cloud\Vision\V1\GcsDestination|null"/> - - setName - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::setName() + + hasGcsDestination + \Google\Cloud\Vision\V1\OutputConfig::hasGcsDestination() - + + + + + + + + + clearGcsDestination + \Google\Cloud\Vision\V1\OutputConfig::clearGcsDestination() + + + + + + + + + + setGcsDestination + \Google\Cloud\Vision\V1\OutputConfig::setGcsDestination() + + var - string + \Google\Cloud\Vision\V1\GcsDestination - - Object name, expressed in its `language_code` language. - Generated from protobuf field <code>string name = 3;</code> + + The Google Cloud Storage location to write the output(s) to. + Generated from protobuf field <code>.google.cloud.vision.v1.GcsDestination gcs_destination = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\GcsDestination"/> - - getScore - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::getScore() + + getBatchSize + \Google\Cloud\Vision\V1\OutputConfig::getBatchSize() - - Score of the result. Range [0, 1]. - Generated from protobuf field <code>float score = 4;</code> + + The max number of response protos to put into each output JSON file on +Google Cloud Storage. + The valid range is [1, 100]. If not specified, the default value is 20. +For example, for one pdf file with 100 pages, 100 response protos will +be generated. If `batch_size` = 20, then 5 json files each +containing 20 response protos will be written under the prefix +`gcs_destination`.`uri`. +Currently, batch_size only applies to GcsDestination, with potential future +support for other output configurations. + +Generated from protobuf field <code>int32 batch_size = 2;</code> + type="int"/> - - setScore - \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::setScore() + + setBatchSize + \Google\Cloud\Vision\V1\OutputConfig::setBatchSize() - + var - float + int - - Score of the result. Range [0, 1]. - Generated from protobuf field <code>float score = 4;</code> + + The max number of response protos to put into each output JSON file on +Google Cloud Storage. + The valid range is [1, 100]. If not specified, the default value is 20. +For example, for one pdf file with 100 pages, 100 response protos will +be generated. If `batch_size` = 20, then 5 json files each +containing 20 response protos will be written under the prefix +`gcs_destination`.`uri`. +Currently, batch_size only applies to GcsDestination, with potential future +support for other output configurations. + +Generated from protobuf field <code>int32 batch_size = 2;</code> + variable="var" type="int"/> - + @@ -33910,18 +19438,19 @@ http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - + - - Result - \Google\Cloud\Vision\V1\ProductSearchResults\Result + + + Page + \Google\Cloud\Vision\V1\Page - Information about a product. - Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchResults.Result</code> + Detected page from OCR. + Generated from protobuf message <code>google.cloud.vision.v1.Page</code> \Google\Protobuf\Internal\Message - - product - \Google\Cloud\Vision\V1\ProductSearchResults\Result::$product + + property + \Google\Cloud\Vision\V1\Page::$property null - The Product. - Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1;</code> + Additional information detected on the page. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - score - \Google\Cloud\Vision\V1\ProductSearchResults\Result::$score - 0.0 + + width + \Google\Cloud\Vision\V1\Page::$width + 0 - A confidence level on the match, ranging from 0 (no confidence) to -1 (full confidence). - Generated from protobuf field <code>float score = 2;</code> + Page width. For PDFs the unit is points. For images (including +TIFFs) the unit is pixels. + Generated from protobuf field <code>int32 width = 2;</code> - - image - \Google\Cloud\Vision\V1\ProductSearchResults\Result::$image - '' + + height + \Google\Cloud\Vision\V1\Page::$height + 0 - The resource name of the image from the product that is the closest match -to the query. - Generated from protobuf field <code>string image = 3;</code> + Page height. For PDFs the unit is points. For images (including +TIFFs) the unit is pixels. + Generated from protobuf field <code>int32 height = 3;</code> + + + + + + blocks + \Google\Cloud\Vision\V1\Page::$blocks + + + List of blocks of text, images etc on this page. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Block blocks = 4;</code> + + + + + + confidence + \Google\Cloud\Vision\V1\Page::$confidence + 0.0 + + Confidence of the OCR results on the page. Range [0, 1]. + Generated from protobuf field <code>float confidence = 5;</code> - + __construct - \Google\Cloud\Vision\V1\ProductSearchResults\Result::__construct() + \Google\Cloud\Vision\V1\Page::__construct() - + data - NULL + null array - + Constructor. - - getProduct - \Google\Cloud\Vision\V1\ProductSearchResults\Result::getProduct() + + getProperty + \Google\Cloud\Vision\V1\Page::getProperty() + + + Additional information detected on the page. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + + + + + + hasProperty + \Google\Cloud\Vision\V1\Page::hasProperty() + + + + + + + + + + clearProperty + \Google\Cloud\Vision\V1\Page::clearProperty() + + + + + + + + + + setProperty + \Google\Cloud\Vision\V1\Page::setProperty() + + + var + + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty + + + + Additional information detected on the page. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + + + + + + + getWidth + \Google\Cloud\Vision\V1\Page::getWidth() - - The Product. - Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1;</code> + + Page width. For PDFs the unit is points. For images (including +TIFFs) the unit is pixels. + Generated from protobuf field <code>int32 width = 2;</code> + type="int"/> - - hasProduct - \Google\Cloud\Vision\V1\ProductSearchResults\Result::hasProduct() + + setWidth + \Google\Cloud\Vision\V1\Page::setWidth() - - - - + + var + + int + + + + Page width. For PDFs the unit is points. For images (including +TIFFs) the unit is pixels. + Generated from protobuf field <code>int32 width = 2;</code> + + + - - clearProduct - \Google\Cloud\Vision\V1\ProductSearchResults\Result::clearProduct() + + getHeight + \Google\Cloud\Vision\V1\Page::getHeight() - - - - + + Page height. For PDFs the unit is points. For images (including +TIFFs) the unit is pixels. + Generated from protobuf field <code>int32 height = 3;</code> + + - - setProduct - \Google\Cloud\Vision\V1\ProductSearchResults\Result::setProduct() + + setHeight + \Google\Cloud\Vision\V1\Page::setHeight() - + var - \Google\Cloud\Vision\V1\Product + int - - The Product. - Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1;</code> + + Page height. For PDFs the unit is points. For images (including +TIFFs) the unit is pixels. + Generated from protobuf field <code>int32 height = 3;</code> + variable="var" type="int"/> - - getScore - \Google\Cloud\Vision\V1\ProductSearchResults\Result::getScore() + + getBlocks + \Google\Cloud\Vision\V1\Page::getBlocks() - - A confidence level on the match, ranging from 0 (no confidence) to -1 (full confidence). - Generated from protobuf field <code>float score = 2;</code> + + List of blocks of text, images etc on this page. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Block blocks = 4;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Block>"/> - - setScore - \Google\Cloud\Vision\V1\ProductSearchResults\Result::setScore() + + setBlocks + \Google\Cloud\Vision\V1\Page::setBlocks() - + var - float + \Google\Cloud\Vision\V1\Block[] - - A confidence level on the match, ranging from 0 (no confidence) to -1 (full confidence). - Generated from protobuf field <code>float score = 2;</code> + + List of blocks of text, images etc on this page. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Block blocks = 4;</code> + variable="var" type="\Google\Cloud\Vision\V1\Block[]"/> - - getImage - \Google\Cloud\Vision\V1\ProductSearchResults\Result::getImage() + + getConfidence + \Google\Cloud\Vision\V1\Page::getConfidence() - - The resource name of the image from the product that is the closest match -to the query. - Generated from protobuf field <code>string image = 3;</code> + + Confidence of the OCR results on the page. Range [0, 1]. + Generated from protobuf field <code>float confidence = 5;</code> + type="float"/> - - setImage - \Google\Cloud\Vision\V1\ProductSearchResults\Result::setImage() + + setConfidence + \Google\Cloud\Vision\V1\Page::setConfidence() - + var - string + float - - The resource name of the image from the product that is the closest match -to the query. - Generated from protobuf field <code>string image = 3;</code> + + Confidence of the OCR results on the page. Range [0, 1]. + Generated from protobuf field <code>float confidence = 5;</code> + variable="var" type="float"/> - + @@ -34158,12 +19789,13 @@ to the query. + - ProductSearchResults - \Google\Cloud\Vision\V1\ProductSearchResults + Paragraph + \Google\Cloud\Vision\V1\Paragraph - Results for a product search request. - Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchResults</code> + Structural unit of text representing a number of words in certain order. + Generated from protobuf message <code>google.cloud.vision.v1.Paragraph</code> \Google\Protobuf\Internal\Message - - index_time - \Google\Cloud\Vision\V1\ProductSearchResults::$index_time + + property + \Google\Cloud\Vision\V1\Paragraph::$property null - - Timestamp of the index which provided these results. Products added to the -product set and products removed from the product set after this time are -not reflected in the current results. - Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 2;</code> + + Additional information detected for the paragraph. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - results - \Google\Cloud\Vision\V1\ProductSearchResults::$results - - - List of results, one for each product match. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 5;</code> + + bounding_box + \Google\Cloud\Vision\V1\Paragraph::$bounding_box + null + + The bounding box for the paragraph. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: + * when the text is horizontal it might look like: + 0----1 + | | + 3----2 + * when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> - - product_grouped_results - \Google\Cloud\Vision\V1\ProductSearchResults::$product_grouped_results + + words + \Google\Cloud\Vision\V1\Paragraph::$words - - List of results grouped by products detected in the query image. Each entry -corresponds to one bounding polygon in the query image, and contains the -matching products specific to that region. There may be duplicate product -matches in the union of all the per-product results. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;</code> + + List of all words in this paragraph. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Word words = 3;</code> + + + + + + confidence + \Google\Cloud\Vision\V1\Paragraph::$confidence + 0.0 + + Confidence of the OCR results for the paragraph. Range [0, 1]. + Generated from protobuf field <code>float confidence = 4;</code> - + __construct - \Google\Cloud\Vision\V1\ProductSearchResults::__construct() + \Google\Cloud\Vision\V1\Paragraph::__construct() - + data - NULL + null array - + Constructor. - - getIndexTime - \Google\Cloud\Vision\V1\ProductSearchResults::getIndexTime() + + getProperty + \Google\Cloud\Vision\V1\Paragraph::getProperty() - - Timestamp of the index which provided these results. Products added to the -product set and products removed from the product set after this time are -not reflected in the current results. - Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 2;</code> + + Additional information detected for the paragraph. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + type="\Google\Cloud\Vision\V1\TextAnnotation\TextProperty|null"/> - - hasIndexTime - \Google\Cloud\Vision\V1\ProductSearchResults::hasIndexTime() + + hasProperty + \Google\Cloud\Vision\V1\Paragraph::hasProperty() - + - - clearIndexTime - \Google\Cloud\Vision\V1\ProductSearchResults::clearIndexTime() + + clearProperty + \Google\Cloud\Vision\V1\Paragraph::clearProperty() - + - - setIndexTime - \Google\Cloud\Vision\V1\ProductSearchResults::setIndexTime() + + setProperty + \Google\Cloud\Vision\V1\Paragraph::setProperty() - + var - \Google\Protobuf\Timestamp + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty - - Timestamp of the index which provided these results. Products added to the -product set and products removed from the product set after this time are -not reflected in the current results. - Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 2;</code> + + Additional information detected for the paragraph. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\TextAnnotation\TextProperty"/> - - getResults - \Google\Cloud\Vision\V1\ProductSearchResults::getResults() + + getBoundingBox + \Google\Cloud\Vision\V1\Paragraph::getBoundingBox() - - List of results, one for each product match. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 5;</code> + + The bounding box for the paragraph. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: + * when the text is horizontal it might look like: + 0----1 + | | + 3----2 + * when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + type="\Google\Cloud\Vision\V1\BoundingPoly|null"/> - - setResults - \Google\Cloud\Vision\V1\ProductSearchResults::setResults() + + hasBoundingBox + \Google\Cloud\Vision\V1\Paragraph::hasBoundingBox() - + + + + + + + + + clearBoundingBox + \Google\Cloud\Vision\V1\Paragraph::clearBoundingBox() + + + + + + + + + + setBoundingBox + \Google\Cloud\Vision\V1\Paragraph::setBoundingBox() + + var - \Google\Cloud\Vision\V1\ProductSearchResults\Result[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\BoundingPoly - - List of results, one for each product match. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 5;</code> + + The bounding box for the paragraph. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: + * when the text is horizontal it might look like: + 0----1 + | | + 3----2 + * when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> - - getProductGroupedResults - \Google\Cloud\Vision\V1\ProductSearchResults::getProductGroupedResults() + + getWords + \Google\Cloud\Vision\V1\Paragraph::getWords() - - List of results grouped by products detected in the query image. Each entry -corresponds to one bounding polygon in the query image, and contains the -matching products specific to that region. There may be duplicate product -matches in the union of all the per-product results. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;</code> + + List of all words in this paragraph. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Word words = 3;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Word>"/> - - setProductGroupedResults - \Google\Cloud\Vision\V1\ProductSearchResults::setProductGroupedResults() + + setWords + \Google\Cloud\Vision\V1\Paragraph::setWords() - + var - \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\Word[] - - List of results grouped by products detected in the query image. Each entry -corresponds to one bounding polygon in the query image, and contains the -matching products specific to that region. There may be duplicate product -matches in the union of all the per-product results. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;</code> + + List of all words in this paragraph. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Word words = 3;</code> + variable="var" type="\Google\Cloud\Vision\V1\Word[]"/> - - - - - - - - - - - - - - - - - - - - - - - ProductSearchResults_GroupedResult - \Google\Cloud\Vision\V1\ProductSearchResults_GroupedResult - - This class is deprecated. Use Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult instead. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ProductSearchResults_ObjectAnnotation - \Google\Cloud\Vision\V1\ProductSearchResults_ObjectAnnotation - - This class is deprecated. Use Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation instead. - + + getConfidence + \Google\Cloud\Vision\V1\Paragraph::getConfidence() + + + Confidence of the OCR results for the paragraph. Range [0, 1]. + Generated from protobuf field <code>float confidence = 4;</code> - + type="float"/> - - - - - - - - - - - - - - - - - + - - - + + setConfidence + \Google\Cloud\Vision\V1\Paragraph::setConfidence() + + + var + + float + - - - - - ProductSearchResults_Result - \Google\Cloud\Vision\V1\ProductSearchResults_Result - - This class is deprecated. Use Google\Cloud\Vision\V1\ProductSearchResults\Result instead. - + + Confidence of the OCR results for the paragraph. Range [0, 1]. + Generated from protobuf field <code>float confidence = 4;</code> - + variable="var" type="float"/> + - - - - + + - + @@ -34541,14 +20144,16 @@ matches in the union of all the per-product results. + - ProductSet - \Google\Cloud\Vision\V1\ProductSet + Position + \Google\Cloud\Vision\V1\Position - A ProductSet contains Products. A ProductSet can contain a maximum of 1 -million reference images. If the limit is exceeded, periodic indexing will -fail. - Generated from protobuf message <code>google.cloud.vision.v1.ProductSet</code> + A 3D position in the image, used primarily for Face detection landmarks. + A valid Position must have both x and y coordinates. +The position coordinates are in the same scale as the original image. + +Generated from protobuf message <code>google.cloud.vision.v1.Position</code> \Google\Protobuf\Internal\Message - - name - \Google\Cloud\Vision\V1\ProductSet::$name - '' - - The resource name of the ProductSet. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. -This field is ignored when creating a ProductSet. - -Generated from protobuf field <code>string name = 1;</code> - - - - - - display_name - \Google\Cloud\Vision\V1\ProductSet::$display_name - '' - - The user-provided name for this ProductSet. Must not be empty. Must be at -most 4096 characters long. - Generated from protobuf field <code>string display_name = 2;</code> + + x + \Google\Cloud\Vision\V1\Position::$x + 0.0 + + X coordinate. + Generated from protobuf field <code>float x = 1;</code> - - index_time - \Google\Cloud\Vision\V1\ProductSet::$index_time - null - - Output only. The time at which this ProductSet was last indexed. Query -results will reflect all updates before this time. If this ProductSet has -never been indexed, this timestamp is the default value -"1970-01-01T00:00:00Z". - This field is ignored when creating a ProductSet. - -Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + + y + \Google\Cloud\Vision\V1\Position::$y + 0.0 + + Y coordinate. + Generated from protobuf field <code>float y = 2;</code> - - index_error - \Google\Cloud\Vision\V1\ProductSet::$index_error - null - - Output only. If there was an error with indexing the product set, the field -is populated. - This field is ignored when creating a ProductSet. - -Generated from protobuf field <code>.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + + z + \Google\Cloud\Vision\V1\Position::$z + 0.0 + + Z coordinate (or depth). + Generated from protobuf field <code>float z = 3;</code> - + __construct - \Google\Cloud\Vision\V1\ProductSet::__construct() + \Google\Cloud\Vision\V1\Position::__construct() - + data - NULL + null array - + Constructor. - - getName - \Google\Cloud\Vision\V1\ProductSet::getName() + + getX + \Google\Cloud\Vision\V1\Position::getX() - - The resource name of the ProductSet. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. -This field is ignored when creating a ProductSet. + + X coordinate. + Generated from protobuf field <code>float x = 1;</code> + + -Generated from protobuf field <code>string name = 1;</code> + + + + setX + \Google\Cloud\Vision\V1\Position::setX() + + + var + + float + + + + X coordinate. + Generated from protobuf field <code>float x = 1;</code> + + type="$this"/> - - setName - \Google\Cloud\Vision\V1\ProductSet::setName() + + getY + \Google\Cloud\Vision\V1\Position::getY() - + + Y coordinate. + Generated from protobuf field <code>float y = 2;</code> + + + + + + + setY + \Google\Cloud\Vision\V1\Position::setY() + + var - string + float - - The resource name of the ProductSet. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. -This field is ignored when creating a ProductSet. + + Y coordinate. + Generated from protobuf field <code>float y = 2;</code> + + + -Generated from protobuf field <code>string name = 1;</code> + + + + getZ + \Google\Cloud\Vision\V1\Position::getZ() + + + Z coordinate (or depth). + Generated from protobuf field <code>float z = 3;</code> + + + + + + + setZ + \Google\Cloud\Vision\V1\Position::setZ() + + + var + + float + + + + Z coordinate (or depth). + Generated from protobuf field <code>float z = 3;</code> + variable="var" type="float"/> - + + + + + + + + + + + + + + + + + + + + + + + + + + KeyValue + \Google\Cloud\Vision\V1\Product\KeyValue + + A product label represented as a key-value pair. + Generated from protobuf message <code>google.cloud.vision.v1.Product.KeyValue</code> + + + + \Google\Protobuf\Internal\Message + + + + key + \Google\Cloud\Vision\V1\Product\KeyValue::$key + '' + + The key of the label attached to the product. Cannot be empty and cannot +exceed 128 bytes. + Generated from protobuf field <code>string key = 1;</code> + + + - - getDisplayName - \Google\Cloud\Vision\V1\ProductSet::getDisplayName() - - - The user-provided name for this ProductSet. Must not be empty. Must be at -most 4096 characters long. - Generated from protobuf field <code>string display_name = 2;</code> - - + + value + \Google\Cloud\Vision\V1\Product\KeyValue::$value + '' + + The value of the label attached to the product. Cannot be empty and +cannot exceed 128 bytes. + Generated from protobuf field <code>string value = 2;</code> + - + - - setDisplayName - \Google\Cloud\Vision\V1\ProductSet::setDisplayName() + + + __construct + \Google\Cloud\Vision\V1\Product\KeyValue::__construct() - - var - - string + + data + null + array - - The user-provided name for this ProductSet. Must not be empty. Must be at -most 4096 characters long. - Generated from protobuf field <code>string display_name = 2;</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type string $key The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. @type string $value The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. }" + variable="data" type="array"/> - - getIndexTime - \Google\Cloud\Vision\V1\ProductSet::getIndexTime() + + getKey + \Google\Cloud\Vision\V1\Product\KeyValue::getKey() - - Output only. The time at which this ProductSet was last indexed. Query -results will reflect all updates before this time. If this ProductSet has -never been indexed, this timestamp is the default value -"1970-01-01T00:00:00Z". - This field is ignored when creating a ProductSet. - -Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + + The key of the label attached to the product. Cannot be empty and cannot +exceed 128 bytes. + Generated from protobuf field <code>string key = 1;</code> + type="string"/> - - hasIndexTime - \Google\Cloud\Vision\V1\ProductSet::hasIndexTime() - - - - - - - - - - clearIndexTime - \Google\Cloud\Vision\V1\ProductSet::clearIndexTime() - - - - - - - - - - setIndexTime - \Google\Cloud\Vision\V1\ProductSet::setIndexTime() + + setKey + \Google\Cloud\Vision\V1\Product\KeyValue::setKey() - + var - \Google\Protobuf\Timestamp + string - - Output only. The time at which this ProductSet was last indexed. Query -results will reflect all updates before this time. If this ProductSet has -never been indexed, this timestamp is the default value -"1970-01-01T00:00:00Z". - This field is ignored when creating a ProductSet. - -Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + + The key of the label attached to the product. Cannot be empty and cannot +exceed 128 bytes. + Generated from protobuf field <code>string key = 1;</code> + variable="var" type="string"/> - - getIndexError - \Google\Cloud\Vision\V1\ProductSet::getIndexError() + + getValue + \Google\Cloud\Vision\V1\Product\KeyValue::getValue() - - Output only. If there was an error with indexing the product set, the field -is populated. - This field is ignored when creating a ProductSet. - -Generated from protobuf field <code>.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + + The value of the label attached to the product. Cannot be empty and +cannot exceed 128 bytes. + Generated from protobuf field <code>string value = 2;</code> + type="string"/> - - hasIndexError - \Google\Cloud\Vision\V1\ProductSet::hasIndexError() - - - - - - - - - - clearIndexError - \Google\Cloud\Vision\V1\ProductSet::clearIndexError() - - - - - - - - - - setIndexError - \Google\Cloud\Vision\V1\ProductSet::setIndexError() + + setValue + \Google\Cloud\Vision\V1\Product\KeyValue::setValue() - + var - \Google\Rpc\Status + string - - Output only. If there was an error with indexing the product set, the field -is populated. - This field is ignored when creating a ProductSet. - -Generated from protobuf field <code>.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + + The value of the label attached to the product. Cannot be empty and +cannot exceed 128 bytes. + Generated from protobuf field <code>string value = 2;</code> + variable="var" type="string"/> - + @@ -34891,65 +20532,131 @@ Generated from protobuf field <code>.google.rpc.Status index_error = 4 [(. + - ProductSetPurgeConfig - \Google\Cloud\Vision\V1\ProductSetPurgeConfig + Product + \Google\Cloud\Vision\V1\Product - Config to control which ProductSet contains the Products to be deleted. - Generated from protobuf message <code>google.cloud.vision.v1.ProductSetPurgeConfig</code> + A Product contains ReferenceImages. + Generated from protobuf message <code>google.cloud.vision.v1.Product</code> - \Google\Protobuf\Internal\Message - - - - product_set_id - \Google\Cloud\Vision\V1\ProductSetPurgeConfig::$product_set_id - '' - - The ProductSet that contains the Products to delete. If a Product is a -member of product_set_id in addition to other ProductSets, the Product will -still be deleted. - Generated from protobuf field <code>string product_set_id = 1;</code> + \Google\Protobuf\Internal\Message + + + + name + \Google\Cloud\Vision\V1\Product::$name + '' + + The resource name of the product. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. +This field is ignored when creating a product. + +Generated from protobuf field <code>string name = 1;</code> + + + + + + display_name + \Google\Cloud\Vision\V1\Product::$display_name + '' + + The user-provided name for this Product. Must not be empty. Must be at most +4096 characters long. + Generated from protobuf field <code>string display_name = 2;</code> + + + + + + description + \Google\Cloud\Vision\V1\Product::$description + '' + + User-provided metadata to be stored with this product. Must be at most 4096 +characters long. + Generated from protobuf field <code>string description = 3;</code> + + + + + + product_category + \Google\Cloud\Vision\V1\Product::$product_category + '' + + Immutable. The category for the product identified by the reference image. + This should be one of "homegoods-v2", "apparel-v2", "toys-v2", +"packagedgoods-v1" or "general-v1". The legacy categories "homegoods", +"apparel", and "toys" are still supported, but these should not be used for +new products. + +Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> + + + + + + product_labels + \Google\Cloud\Vision\V1\Product::$product_labels + + + Key-value pairs that can be attached to a product. At query time, +constraints can be specified based on the product_labels. + Note that integer values can be provided as strings, e.g. "1199". Only +strings with integer values can match a range-based restriction which is +to be supported soon. +Multiple values can be assigned to the same key. One product may have up to +500 product_labels. +Notice that the total number of distinct product_labels over all products +in one ProductSet cannot exceed 1M, otherwise the product search pipeline +will refuse to work for that ProductSet. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;</code> - + __construct - \Google\Cloud\Vision\V1\ProductSetPurgeConfig::__construct() + \Google\Cloud\Vision\V1\Product::__construct() - + data - NULL + null array - + Constructor. - - getProductSetId - \Google\Cloud\Vision\V1\ProductSetPurgeConfig::getProductSetId() + + getName + \Google\Cloud\Vision\V1\Product::getName() - - The ProductSet that contains the Products to delete. If a Product is a -member of product_set_id in addition to other ProductSets, the Product will -still be deleted. - Generated from protobuf field <code>string product_set_id = 1;</code> + + The resource name of the product. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. +This field is ignored when creating a product. + +Generated from protobuf field <code>string name = 1;</code> - - setProductSetId - \Google\Cloud\Vision\V1\ProductSetPurgeConfig::setProductSetId() + + setName + \Google\Cloud\Vision\V1\Product::setName() - + var string - - The ProductSet that contains the Products to delete. If a Product is a -member of product_set_id in addition to other ProductSets, the Product will -still be deleted. - Generated from protobuf field <code>string product_set_id = 1;</code> + + The resource name of the product. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. +This field is ignored when creating a product. + +Generated from protobuf field <code>string name = 1;</code> - - - - - - - - - - - - - - - - - - - - - - - Property - \Google\Cloud\Vision\V1\Property - - A `Property` consists of a user-supplied name/value pair. - Generated from protobuf message <code>google.cloud.vision.v1.Property</code> + + getDisplayName + \Google\Cloud\Vision\V1\Product::getDisplayName() + + + The user-provided name for this Product. Must not be empty. Must be at most +4096 characters long. + Generated from protobuf field <code>string display_name = 2;</code> + name="return" + description="" + type="string"/> - \Google\Protobuf\Internal\Message - - - - name - \Google\Cloud\Vision\V1\Property::$name - '' - - Name of the property. - Generated from protobuf field <code>string name = 1;</code> - - - - - - value - \Google\Cloud\Vision\V1\Property::$value - '' - - Value of the property. - Generated from protobuf field <code>string value = 2;</code> - - - - - - uint64_value - \Google\Cloud\Vision\V1\Property::$uint64_value - 0 - - Value of numeric properties. - Generated from protobuf field <code>uint64 uint64_value = 3;</code> - - - + - - - __construct - \Google\Cloud\Vision\V1\Property::__construct() + + setDisplayName + \Google\Cloud\Vision\V1\Product::setDisplayName() - - data - NULL - array + + var + + string - - Constructor. - + + The user-provided name for this Product. Must not be empty. Must be at most +4096 characters long. + Generated from protobuf field <code>string display_name = 2;</code> + description="" + variable="var" type="string"/> + - - getName - \Google\Cloud\Vision\V1\Property::getName() + + getDescription + \Google\Cloud\Vision\V1\Product::getDescription() - - Name of the property. - Generated from protobuf field <code>string name = 1;</code> + + User-provided metadata to be stored with this product. Must be at most 4096 +characters long. + Generated from protobuf field <code>string description = 3;</code> - - setName - \Google\Cloud\Vision\V1\Property::setName() + + setDescription + \Google\Cloud\Vision\V1\Product::setDescription() - + var string - - Name of the property. - Generated from protobuf field <code>string name = 1;</code> + + User-provided metadata to be stored with this product. Must be at most 4096 +characters long. + Generated from protobuf field <code>string description = 3;</code> - - getValue - \Google\Cloud\Vision\V1\Property::getValue() + + getProductCategory + \Google\Cloud\Vision\V1\Product::getProductCategory() - - Value of the property. - Generated from protobuf field <code>string value = 2;</code> + + Immutable. The category for the product identified by the reference image. + This should be one of "homegoods-v2", "apparel-v2", "toys-v2", +"packagedgoods-v1" or "general-v1". The legacy categories "homegoods", +"apparel", and "toys" are still supported, but these should not be used for +new products. + +Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> - - setValue - \Google\Cloud\Vision\V1\Property::setValue() + + setProductCategory + \Google\Cloud\Vision\V1\Product::setProductCategory() - + var string - - Value of the property. - Generated from protobuf field <code>string value = 2;</code> + + Immutable. The category for the product identified by the reference image. + This should be one of "homegoods-v2", "apparel-v2", "toys-v2", +"packagedgoods-v1" or "general-v1". The legacy categories "homegoods", +"apparel", and "toys" are still supported, but these should not be used for +new products. + +Generated from protobuf field <code>string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> - - getUint64Value - \Google\Cloud\Vision\V1\Property::getUint64Value() - - - Value of numeric properties. - Generated from protobuf field <code>uint64 uint64_value = 3;</code> + + getProductLabels + \Google\Cloud\Vision\V1\Product::getProductLabels() + + + Key-value pairs that can be attached to a product. At query time, +constraints can be specified based on the product_labels. + Note that integer values can be provided as strings, e.g. "1199". Only +strings with integer values can match a range-based restriction which is +to be supported soon. +Multiple values can be assigned to the same key. One product may have up to +500 product_labels. +Notice that the total number of distinct product_labels over all products +in one ProductSet cannot exceed 1M, otherwise the product search pipeline +will refuse to work for that ProductSet. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Product\KeyValue>"/> - - setUint64Value - \Google\Cloud\Vision\V1\Property::setUint64Value() + + setProductLabels + \Google\Cloud\Vision\V1\Product::setProductLabels() - + var - int|string + \Google\Cloud\Vision\V1\Product\KeyValue[] - - Value of numeric properties. - Generated from protobuf field <code>uint64 uint64_value = 3;</code> + + Key-value pairs that can be attached to a product. At query time, +constraints can be specified based on the product_labels. + Note that integer values can be provided as strings, e.g. "1199". Only +strings with integer values can match a range-based restriction which is +to be supported soon. +Multiple values can be assigned to the same key. One product may have up to +500 product_labels. +Notice that the total number of distinct product_labels over all products +in one ProductSet cannot exceed 1M, otherwise the product search pipeline +will refuse to work for that ProductSet. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;</code> + variable="var" type="\Google\Cloud\Vision\V1\Product\KeyValue[]"/> - + @@ -35223,12 +20912,13 @@ still be deleted. + - PurgeProductsRequest - \Google\Cloud\Vision\V1\PurgeProductsRequest + ProductSearchParams + \Google\Cloud\Vision\V1\ProductSearchParams - Request message for the `PurgeProducts` method. - Generated from protobuf message <code>google.cloud.vision.v1.PurgeProductsRequest</code> + Parameters for a product search request. + Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchParams</code> \Google\Protobuf\Internal\Message - - parent - \Google\Cloud\Vision\V1\PurgeProductsRequest::$parent - '' + + bounding_poly + \Google\Cloud\Vision\V1\ProductSearchParams::$bounding_poly + null - Required. The project and location in which the Products should be deleted. - Format is `projects/PROJECT_ID/locations/LOC_ID`. + The bounding polygon around the area of interest in the image. + If it is not specified, system discretion will be applied. -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 9;</code> - - force - \Google\Cloud\Vision\V1\PurgeProductsRequest::$force - false - - The default value is false. Override this value to true to actually perform -the purge. - Generated from protobuf field <code>bool force = 4;</code> + + product_set + \Google\Cloud\Vision\V1\ProductSearchParams::$product_set + '' + + The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to +be searched for similar images. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + +Generated from protobuf field <code>string product_set = 6 [(.google.api.resource_reference) = {</code> - - target - \Google\Cloud\Vision\V1\PurgeProductsRequest::$target + + product_categories + \Google\Cloud\Vision\V1\ProductSearchParams::$product_categories - - - + + The list of product categories to search in. Currently, we only consider +the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", +"packagedgoods-v1", or "general-v1" should be specified. The legacy +categories "homegoods", "apparel", and "toys" are still supported but will +be deprecated. For new products, please use "homegoods-v2", "apparel-v2", +or "toys-v2" for better product search accuracy. It is recommended to +migrate existing products to these categories as well. + Generated from protobuf field <code>repeated string product_categories = 7;</code> - - - build - \Google\Cloud\Vision\V1\PurgeProductsRequest::build() - - - parent - - string - + + filter + \Google\Cloud\Vision\V1\ProductSearchParams::$filter + '' + + The filtering expression. This can be used to restrict search results based +on Product labels. We currently support an AND of OR of key-value +expressions, where each expression within an OR must have the same key. An +'=' should be used to connect the key and value. + For example, "(color = red OR color = blue) AND brand = Google" is +acceptable, but "(color = red OR brand = Google)" is not acceptable. +"color: red" is not acceptable because it uses a ':' instead of an '='. - - - - - - - +Generated from protobuf field <code>string filter = 8;</code> + - + - + + __construct - \Google\Cloud\Vision\V1\PurgeProductsRequest::__construct() + \Google\Cloud\Vision\V1\ProductSearchParams::__construct() - + data - NULL + null array - + Constructor. - - getProductSetPurgeConfig - \Google\Cloud\Vision\V1\PurgeProductsRequest::getProductSetPurgeConfig() + + getBoundingPoly + \Google\Cloud\Vision\V1\ProductSearchParams::getBoundingPoly() - - Specify which ProductSet contains the Products to be deleted. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;</code> + + The bounding polygon around the area of interest in the image. + If it is not specified, system discretion will be applied. + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 9;</code> + type="\Google\Cloud\Vision\V1\BoundingPoly|null"/> - - hasProductSetPurgeConfig - \Google\Cloud\Vision\V1\PurgeProductsRequest::hasProductSetPurgeConfig() + + hasBoundingPoly + \Google\Cloud\Vision\V1\ProductSearchParams::hasBoundingPoly() - + - - setProductSetPurgeConfig - \Google\Cloud\Vision\V1\PurgeProductsRequest::setProductSetPurgeConfig() - - - var - - \Google\Cloud\Vision\V1\ProductSetPurgeConfig - - - - Specify which ProductSet contains the Products to be deleted. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;</code> - - - - - - - - getDeleteOrphanProducts - \Google\Cloud\Vision\V1\PurgeProductsRequest::getDeleteOrphanProducts() - - - If delete_orphan_products is true, all Products that are not in any -ProductSet will be deleted. - Generated from protobuf field <code>bool delete_orphan_products = 3;</code> - - - - - - - hasDeleteOrphanProducts - \Google\Cloud\Vision\V1\PurgeProductsRequest::hasDeleteOrphanProducts() + + clearBoundingPoly + \Google\Cloud\Vision\V1\ProductSearchParams::clearBoundingPoly() - + - - setDeleteOrphanProducts - \Google\Cloud\Vision\V1\PurgeProductsRequest::setDeleteOrphanProducts() + + setBoundingPoly + \Google\Cloud\Vision\V1\ProductSearchParams::setBoundingPoly() - + var - bool + \Google\Cloud\Vision\V1\BoundingPoly - - If delete_orphan_products is true, all Products that are not in any -ProductSet will be deleted. - Generated from protobuf field <code>bool delete_orphan_products = 3;</code> + + The bounding polygon around the area of interest in the image. + If it is not specified, system discretion will be applied. + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 9;</code> + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> - - getParent - \Google\Cloud\Vision\V1\PurgeProductsRequest::getParent() + + getProductSet + \Google\Cloud\Vision\V1\ProductSearchParams::getProductSet() - - Required. The project and location in which the Products should be deleted. - Format is `projects/PROJECT_ID/locations/LOC_ID`. + + The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to +be searched for similar images. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>string product_set = 6 [(.google.api.resource_reference) = {</code> - - setParent - \Google\Cloud\Vision\V1\PurgeProductsRequest::setParent() + + setProductSet + \Google\Cloud\Vision\V1\ProductSearchParams::setProductSet() var @@ -35457,10 +21109,12 @@ Generated from protobuf field <code>string parent = 1 [(.google.api.field_ - Required. The project and location in which the Products should be deleted. - Format is `projects/PROJECT_ID/locations/LOC_ID`. + The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to +be searched for similar images. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. -Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> +Generated from protobuf field <code>string product_set = 6 [(.google.api.resource_reference) = {</code> - - getForce - \Google\Cloud\Vision\V1\PurgeProductsRequest::getForce() + + getProductCategories + \Google\Cloud\Vision\V1\ProductSearchParams::getProductCategories() - - The default value is false. Override this value to true to actually perform -the purge. - Generated from protobuf field <code>bool force = 4;</code> + + The list of product categories to search in. Currently, we only consider +the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", +"packagedgoods-v1", or "general-v1" should be specified. The legacy +categories "homegoods", "apparel", and "toys" are still supported but will +be deprecated. For new products, please use "homegoods-v2", "apparel-v2", +or "toys-v2" for better product search accuracy. It is recommended to +migrate existing products to these categories as well. + Generated from protobuf field <code>repeated string product_categories = 7;</code> + type="\Google\Protobuf\RepeatedField<string>"/> - - setForce - \Google\Cloud\Vision\V1\PurgeProductsRequest::setForce() + + setProductCategories + \Google\Cloud\Vision\V1\ProductSearchParams::setProductCategories() - + var - bool + string[] - - The default value is false. Override this value to true to actually perform -the purge. - Generated from protobuf field <code>bool force = 4;</code> + + The list of product categories to search in. Currently, we only consider +the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", +"packagedgoods-v1", or "general-v1" should be specified. The legacy +categories "homegoods", "apparel", and "toys" are still supported but will +be deprecated. For new products, please use "homegoods-v2", "apparel-v2", +or "toys-v2" for better product search accuracy. It is recommended to +migrate existing products to these categories as well. + Generated from protobuf field <code>repeated string product_categories = 7;</code> + variable="var" type="string[]"/> - - getTarget - \Google\Cloud\Vision\V1\PurgeProductsRequest::getTarget() + + getFilter + \Google\Cloud\Vision\V1\ProductSearchParams::getFilter() - - - + + The filtering expression. This can be used to restrict search results based +on Product labels. We currently support an AND of OR of key-value +expressions, where each expression within an OR must have the same key. An +'=' should be used to connect the key and value. + For example, "(color = red OR color = blue) AND brand = Google" is +acceptable, but "(color = red OR brand = Google)" is not acceptable. +"color: red" is not acceptable because it uses a ':' instead of an '='. + +Generated from protobuf field <code>string filter = 8;</code> + + + + setFilter + \Google\Cloud\Vision\V1\ProductSearchParams::setFilter() + + + var + + string + + + + The filtering expression. This can be used to restrict search results based +on Product labels. We currently support an AND of OR of key-value +expressions, where each expression within an OR must have the same key. An +'=' should be used to connect the key and value. + For example, "(color = red OR color = blue) AND brand = Google" is +acceptable, but "(color = red OR brand = Google)" is not acceptable. +"color: red" is not acceptable because it uses a ':' instead of an '='. + +Generated from protobuf field <code>string filter = 8;</code> + + + + @@ -35536,7 +21239,7 @@ the purge. - + @@ -35548,19 +21251,20 @@ the purge. - + - - ReferenceImage - \Google\Cloud\Vision\V1\ReferenceImage + + + GroupedResult + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult - A `ReferenceImage` represents a product image and its associated metadata, -such as bounding boxes. - Generated from protobuf message <code>google.cloud.vision.v1.ReferenceImage</code> + Information about the products similar to a single product in a query +image. + Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchResults.GroupedResult</code> \Google\Protobuf\Internal\Message - - name - \Google\Cloud\Vision\V1\ReferenceImage::$name - '' - - The resource name of the reference image. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. -This field is ignored when creating a reference image. - -Generated from protobuf field <code>string name = 1;</code> + + bounding_poly + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::$bounding_poly + null + + The bounding polygon around the product detected in the query image. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> - - uri - \Google\Cloud\Vision\V1\ReferenceImage::$uri - '' - - Required. The Google Cloud Storage URI of the reference image. - The URI must start with `gs://`. - -Generated from protobuf field <code>string uri = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + results + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::$results + + + List of results, one for each product match. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 2;</code> - - bounding_polys - \Google\Cloud\Vision\V1\ReferenceImage::$bounding_polys + + object_annotations + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::$object_annotations - - Optional. Bounding polygons around the areas of interest in the reference -image. If this field is empty, the system will try to detect regions of -interest. At most 10 bounding polygons will be used. - The provided shape is converted into a non-rotated rectangle. Once -converted, the small edge of the rectangle must be greater than or equal -to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 -is not). - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];</code> + + List of generic predictions for the object in the bounding box. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation object_annotations = 3;</code> - + __construct - \Google\Cloud\Vision\V1\ReferenceImage::__construct() + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::__construct() - + data - NULL + null array - + Constructor. - - getName - \Google\Cloud\Vision\V1\ReferenceImage::getName() + + getBoundingPoly + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::getBoundingPoly() - - The resource name of the reference image. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. -This field is ignored when creating a reference image. - -Generated from protobuf field <code>string name = 1;</code> + + The bounding polygon around the product detected in the query image. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + type="\Google\Cloud\Vision\V1\BoundingPoly|null"/> - - setName - \Google\Cloud\Vision\V1\ReferenceImage::setName() + + hasBoundingPoly + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::hasBoundingPoly() - + + + + + + + + + clearBoundingPoly + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::clearBoundingPoly() + + + + + + + + + + setBoundingPoly + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::setBoundingPoly() + + var - string + \Google\Cloud\Vision\V1\BoundingPoly - - The resource name of the reference image. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. -This field is ignored when creating a reference image. - -Generated from protobuf field <code>string name = 1;</code> + + The bounding polygon around the product detected in the query image. + Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> - - getUri - \Google\Cloud\Vision\V1\ReferenceImage::getUri() + + getResults + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::getResults() - - Required. The Google Cloud Storage URI of the reference image. - The URI must start with `gs://`. - -Generated from protobuf field <code>string uri = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + List of results, one for each product match. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 2;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\ProductSearchResults\Result>"/> - - setUri - \Google\Cloud\Vision\V1\ReferenceImage::setUri() + + setResults + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::setResults() - + var - string + \Google\Cloud\Vision\V1\ProductSearchResults\Result[] - - Required. The Google Cloud Storage URI of the reference image. - The URI must start with `gs://`. - -Generated from protobuf field <code>string uri = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + List of results, one for each product match. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 2;</code> + variable="var" type="\Google\Cloud\Vision\V1\ProductSearchResults\Result[]"/> - - getBoundingPolys - \Google\Cloud\Vision\V1\ReferenceImage::getBoundingPolys() + + getObjectAnnotations + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::getObjectAnnotations() - - Optional. Bounding polygons around the areas of interest in the reference -image. If this field is empty, the system will try to detect regions of -interest. At most 10 bounding polygons will be used. - The provided shape is converted into a non-rotated rectangle. Once -converted, the small edge of the rectangle must be greater than or equal -to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 -is not). - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];</code> + + List of generic predictions for the object in the bounding box. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation object_annotations = 3;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation>"/> - - setBoundingPolys - \Google\Cloud\Vision\V1\ReferenceImage::setBoundingPolys() + + setObjectAnnotations + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::setObjectAnnotations() - + var - \Google\Cloud\Vision\V1\BoundingPoly[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation[] - - Optional. Bounding polygons around the areas of interest in the reference -image. If this field is empty, the system will try to detect regions of -interest. At most 10 bounding polygons will be used. - The provided shape is converted into a non-rotated rectangle. Once -converted, the small edge of the rectangle must be greater than or equal -to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 -is not). - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];</code> + + List of generic predictions for the object in the bounding box. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation object_annotations = 3;</code> + variable="var" type="\Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation[]"/> - + @@ -35802,18 +21489,19 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Bound - + - - RemoveProductFromProductSetRequest - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest + + + ObjectAnnotation + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation - Request message for the `RemoveProductFromProductSet` method. - Generated from protobuf message <code>google.cloud.vision.v1.RemoveProductFromProductSetRequest</code> + Prediction for what the object in the bounding box is. + Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation</code> \Google\Protobuf\Internal\Message - - name - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::$name + + mid + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::$mid '' - - Required. The resource name for the ProductSet to modify. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + + Object ID that should align with EntityAnnotation mid. + Generated from protobuf field <code>string mid = 1;</code> + -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + language_code + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::$language_code + '' + + The BCP-47 language code, such as "en-US" or "sr-Latn". For more +information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + Generated from protobuf field <code>string language_code = 2;</code> - - product - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::$product + + name + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::$name '' - - Required. The resource name for the Product to be removed from this -ProductSet. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + + Object name, expressed in its `language_code` language. + Generated from protobuf field <code>string name = 3;</code> + -Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + score + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::$score + 0.0 + + Score of the result. Range [0, 1]. + Generated from protobuf field <code>float score = 4;</code> - - build - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::build() + + __construct + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::__construct() - - name - - string + + data + null + array - - product + + Constructor. + + + + + + + + getMid + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::getMid() + + + Object ID that should align with EntityAnnotation mid. + Generated from protobuf field <code>string mid = 1;</code> + + + + + + + setMid + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::setMid() + + + var string - - - + + Object ID that should align with EntityAnnotation mid. + Generated from protobuf field <code>string mid = 1;</code> - + description="" + variable="var" type="string"/> - + + + + + + getLanguageCode + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::getLanguageCode() + + + The BCP-47 language code, such as "en-US" or "sr-Latn". For more +information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + Generated from protobuf field <code>string language_code = 2;</code> + + type="string"/> - - __construct - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::__construct() + + setLanguageCode + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::setLanguageCode() - - data - NULL - array + + var + + string - - Constructor. - + + The BCP-47 language code, such as "en-US" or "sr-Latn". For more +information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + Generated from protobuf field <code>string language_code = 2;</code> + description="" + variable="var" type="string"/> + - + getName - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::getName() + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::getName() - - Required. The resource name for the ProductSet to modify. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` - -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + Object name, expressed in its `language_code` language. + Generated from protobuf field <code>string name = 3;</code> - + setName - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::setName() + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::setName() - - var - - string - - - - Required. The resource name for the ProductSet to modify. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + + var + + string + -Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + Object name, expressed in its `language_code` language. + Generated from protobuf field <code>string name = 3;</code> - - getProduct - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::getProduct() + + getScore + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::getScore() - - Required. The resource name for the Product to be removed from this -ProductSet. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + Score of the result. Range [0, 1]. + Generated from protobuf field <code>float score = 4;</code> + type="float"/> - - setProduct - \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::setProduct() + + setScore + \Google\Cloud\Vision\V1\ProductSearchResults\ObjectAnnotation::setScore() - + var - string + float - - Required. The resource name for the Product to be removed from this -ProductSet. - Format is: -`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` - -Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + Score of the result. Range [0, 1]. + Generated from protobuf field <code>float score = 4;</code> + variable="var" type="float"/> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -36091,42 +21761,19 @@ Generated from protobuf field <code>string product = 2 [(.google.api.field + - - - - - - - - - - - - - - - - - - - - - SafeSearchAnnotation - \Google\Cloud\Vision\V1\SafeSearchAnnotation - - Set of features pertaining to the image, computed by computer vision -methods over safe-search verticals (for example, adult, spoof, medical, -violence). - Generated from protobuf message <code>google.cloud.vision.v1.SafeSearchAnnotation</code> + + Result + \Google\Cloud\Vision\V1\ProductSearchResults\Result + + Information about a product. + Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchResults.Result</code> \Google\Protobuf\Internal\Message - - adult - \Google\Cloud\Vision\V1\SafeSearchAnnotation::$adult - 0 - - Represents the adult content likelihood for the image. Adult content may -contain elements such as nudity, pornographic images or cartoons, or -sexual activities. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood adult = 1;</code> + + product + \Google\Cloud\Vision\V1\ProductSearchResults\Result::$product + null + + The Product. + Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1;</code> - - spoof - \Google\Cloud\Vision\V1\SafeSearchAnnotation::$spoof - 0 - - Spoof likelihood. The likelihood that an modification -was made to the image's canonical version to make it appear -funny or offensive. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood spoof = 2;</code> + + score + \Google\Cloud\Vision\V1\ProductSearchResults\Result::$score + 0.0 + + A confidence level on the match, ranging from 0 (no confidence) to +1 (full confidence). + Generated from protobuf field <code>float score = 2;</code> - - medical - \Google\Cloud\Vision\V1\SafeSearchAnnotation::$medical - 0 - - Likelihood that this is a medical image. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood medical = 3;</code> + + image + \Google\Cloud\Vision\V1\ProductSearchResults\Result::$image + '' + + The resource name of the image from the product that is the closest match +to the query. + Generated from protobuf field <code>string image = 3;</code> - - violence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::$violence - 0 - - Likelihood that this image contains violent content. Violent content may -include death, serious harm, or injury to individuals or groups of -individuals. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood violence = 4;</code> - + + + __construct + \Google\Cloud\Vision\V1\ProductSearchResults\Result::__construct() + + + data + null + array + - + + Constructor. + + + - - racy - \Google\Cloud\Vision\V1\SafeSearchAnnotation::$racy - 0 - - Likelihood that the request image contains racy content. Racy content may -include (but is not limited to) skimpy or sheer clothing, strategically -covered nudity, lewd or provocative poses, or close-ups of sensitive -body areas. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood racy = 9;</code> - + + + + getProduct + \Google\Cloud\Vision\V1\ProductSearchResults\Result::getProduct() + + + The Product. + Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1;</code> + + + + + + + hasProduct + \Google\Cloud\Vision\V1\ProductSearchResults\Result::hasProduct() + + + + + - + - - - __construct - \Google\Cloud\Vision\V1\SafeSearchAnnotation::__construct() + + clearProduct + \Google\Cloud\Vision\V1\ProductSearchResults\Result::clearProduct() - - data - NULL - array + + + + + + + + + setProduct + \Google\Cloud\Vision\V1\ProductSearchResults\Result::setProduct() + + + var + + \Google\Cloud\Vision\V1\Product - - Constructor. - + + The Product. + Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\Product"/> + - - getAdult - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getAdult() + + getScore + \Google\Cloud\Vision\V1\ProductSearchResults\Result::getScore() - - Represents the adult content likelihood for the image. Adult content may -contain elements such as nudity, pornographic images or cartoons, or -sexual activities. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood adult = 1;</code> + + A confidence level on the match, ranging from 0 (no confidence) to +1 (full confidence). + Generated from protobuf field <code>float score = 2;</code> + type="float"/> - - setAdult - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setAdult() + + setScore + \Google\Cloud\Vision\V1\ProductSearchResults\Result::setScore() - + var - int + float - - Represents the adult content likelihood for the image. Adult content may -contain elements such as nudity, pornographic images or cartoons, or -sexual activities. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood adult = 1;</code> + + A confidence level on the match, ranging from 0 (no confidence) to +1 (full confidence). + Generated from protobuf field <code>float score = 2;</code> + variable="var" type="float"/> - - getSpoof - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getSpoof() + + getImage + \Google\Cloud\Vision\V1\ProductSearchResults\Result::getImage() - - Spoof likelihood. The likelihood that an modification -was made to the image's canonical version to make it appear -funny or offensive. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood spoof = 2;</code> + + The resource name of the image from the product that is the closest match +to the query. + Generated from protobuf field <code>string image = 3;</code> + type="string"/> - - setSpoof - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setSpoof() + + setImage + \Google\Cloud\Vision\V1\ProductSearchResults\Result::setImage() var - int + string - Spoof likelihood. The likelihood that an modification -was made to the image's canonical version to make it appear -funny or offensive. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood spoof = 2;</code> + The resource name of the image from the product that is the closest match +to the query. + Generated from protobuf field <code>string image = 3;</code> + variable="var" type="string"/> - - getMedical - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getMedical() - - - Likelihood that this is a medical image. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood medical = 3;</code> + + + + + + + + + + + name="package" + description="Application" + /> + + + + + + + + + + + + + ProductSearchResults + \Google\Cloud\Vision\V1\ProductSearchResults + + Results for a product search request. + Generated from protobuf message <code>google.cloud.vision.v1.ProductSearchResults</code> + - + \Google\Protobuf\Internal\Message + + + + index_time + \Google\Cloud\Vision\V1\ProductSearchResults::$index_time + null + + Timestamp of the index which provided these results. Products added to the +product set and products removed from the product set after this time are +not reflected in the current results. + Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 2;</code> + - - setMedical - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setMedical() - - - var + + + + results + \Google\Cloud\Vision\V1\ProductSearchResults::$results - int + + List of results, one for each product match. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 5;</code> + + + + + + product_grouped_results + \Google\Cloud\Vision\V1\ProductSearchResults::$product_grouped_results + + + List of results grouped by products detected in the query image. Each entry +corresponds to one bounding polygon in the query image, and contains the +matching products specific to that region. There may be duplicate product +matches in the union of all the per-product results. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\ProductSearchResults::__construct() + + + data + null + array - - Likelihood that this is a medical image. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood medical = 3;</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type \Google\Protobuf\Timestamp $index_time Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. @type \Google\Cloud\Vision\V1\ProductSearchResults\Result[] $results List of results, one for each product match. @type \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult[] $product_grouped_results List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. }" + variable="data" type="array"/> - - getViolence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getViolence() + + getIndexTime + \Google\Cloud\Vision\V1\ProductSearchResults::getIndexTime() - - Likelihood that this image contains violent content. Violent content may -include death, serious harm, or injury to individuals or groups of -individuals. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood violence = 4;</code> + + Timestamp of the index which provided these results. Products added to the +product set and products removed from the product set after this time are +not reflected in the current results. + Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 2;</code> + type="\Google\Protobuf\Timestamp|null"/> - - setViolence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setViolence() + + hasIndexTime + \Google\Cloud\Vision\V1\ProductSearchResults::hasIndexTime() + + + + + + + + + + clearIndexTime + \Google\Cloud\Vision\V1\ProductSearchResults::clearIndexTime() + + + + + + + + + + setIndexTime + \Google\Cloud\Vision\V1\ProductSearchResults::setIndexTime() - + var - int + \Google\Protobuf\Timestamp - - Likelihood that this image contains violent content. Violent content may -include death, serious harm, or injury to individuals or groups of -individuals. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood violence = 4;</code> + + Timestamp of the index which provided these results. Products added to the +product set and products removed from the product set after this time are +not reflected in the current results. + Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 2;</code> + variable="var" type="\Google\Protobuf\Timestamp"/> - - getRacy - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getRacy() + + getResults + \Google\Cloud\Vision\V1\ProductSearchResults::getResults() - - Likelihood that the request image contains racy content. Racy content may -include (but is not limited to) skimpy or sheer clothing, strategically -covered nudity, lewd or provocative poses, or close-ups of sensitive -body areas. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood racy = 9;</code> + + List of results, one for each product match. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 5;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\ProductSearchResults\Result>"/> - - setRacy - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setRacy() + + setResults + \Google\Cloud\Vision\V1\ProductSearchResults::setResults() - + var - int + \Google\Cloud\Vision\V1\ProductSearchResults\Result[] - - Likelihood that the request image contains racy content. Racy content may -include (but is not limited to) skimpy or sheer clothing, strategically -covered nudity, lewd or provocative poses, or close-ups of sensitive -body areas. - Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood racy = 9;</code> + + List of results, one for each product match. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.Result results = 5;</code> + variable="var" type="\Google\Cloud\Vision\V1\ProductSearchResults\Result[]"/> - - getAdultConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getAdultConfidence() + + getProductGroupedResults + \Google\Cloud\Vision\V1\ProductSearchResults::getProductGroupedResults() - - Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means -very confident. - Generated from protobuf field <code>float adult_confidence = 16 [deprecated = true];</code> + + List of results grouped by products detected in the query image. Each entry +corresponds to one bounding polygon in the query image, and contains the +matching products specific to that region. There may be duplicate product +matches in the union of all the per-product results. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;</code> - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult>"/> - - setAdultConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setAdultConfidence() + + setProductGroupedResults + \Google\Cloud\Vision\V1\ProductSearchResults::setProductGroupedResults() - + var - float + \Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult[] - - Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means -very confident. - Generated from protobuf field <code>float adult_confidence = 16 [deprecated = true];</code> + + List of results grouped by products detected in the query image. Each entry +corresponds to one bounding polygon in the query image, and contains the +matching products specific to that region. There may be duplicate product +matches in the union of all the per-product results. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.ProductSearchResults.GroupedResult product_grouped_results = 6;</code> + variable="var" type="\Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult[]"/> - - - getSpoofConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getSpoofConfidence() - - - Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means -very confident. - Generated from protobuf field <code>float spoof_confidence = 18 [deprecated = true];</code> + + + + + + + + + + - + + + + + + + + + + + + + ProductSet + \Google\Cloud\Vision\V1\ProductSet + + A ProductSet contains Products. A ProductSet can contain a maximum of 1 +million reference images. If the limit is exceeded, periodic indexing will +fail. + Generated from protobuf message <code>google.cloud.vision.v1.ProductSet</code> + - + \Google\Protobuf\Internal\Message + + + + name + \Google\Cloud\Vision\V1\ProductSet::$name + '' + + The resource name of the ProductSet. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. +This field is ignored when creating a ProductSet. + +Generated from protobuf field <code>string name = 1;</code> + + + + + + display_name + \Google\Cloud\Vision\V1\ProductSet::$display_name + '' + + The user-provided name for this ProductSet. Must not be empty. Must be at +most 4096 characters long. + Generated from protobuf field <code>string display_name = 2;</code> + + + + + + index_time + \Google\Cloud\Vision\V1\ProductSet::$index_time + null + + Output only. The time at which this ProductSet was last indexed. Query +results will reflect all updates before this time. If this ProductSet has +never been indexed, this timestamp is the default value +"1970-01-01T00:00:00Z". + This field is ignored when creating a ProductSet. + +Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + + + + + + index_error + \Google\Cloud\Vision\V1\ProductSet::$index_error + null + + Output only. If there was an error with indexing the product set, the field +is populated. + This field is ignored when creating a ProductSet. + +Generated from protobuf field <code>.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + - - setSpoofConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setSpoofConfidence() + + + + + __construct + \Google\Cloud\Vision\V1\ProductSet::__construct() - - var - - float + + data + null + array - - Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means -very confident. - Generated from protobuf field <code>float spoof_confidence = 18 [deprecated = true];</code> + + Constructor. + - - + description="{ Optional. Data for populating the Message object. @type string $name The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. @type string $display_name The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long. @type \Google\Protobuf\Timestamp $index_time Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. @type \Google\Rpc\Status $index_error Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet. }" + variable="data" type="array"/> - - getMedicalConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getMedicalConfidence() + + getName + \Google\Cloud\Vision\V1\ProductSet::getName() - - Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means -very confident. - Generated from protobuf field <code>float medical_confidence = 20 [deprecated = true];</code> + + The resource name of the ProductSet. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. +This field is ignored when creating a ProductSet. + +Generated from protobuf field <code>string name = 1;</code> - + type="string"/> - - setMedicalConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setMedicalConfidence() + + setName + \Google\Cloud\Vision\V1\ProductSet::setName() - + var - float + string - - Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means -very confident. - Generated from protobuf field <code>float medical_confidence = 20 [deprecated = true];</code> + + The resource name of the ProductSet. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. +This field is ignored when creating a ProductSet. + +Generated from protobuf field <code>string name = 1;</code> + variable="var" type="string"/> - - - getViolenceConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getViolenceConfidence() + + getDisplayName + \Google\Cloud\Vision\V1\ProductSet::getDisplayName() - - Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means -very confident. - Generated from protobuf field <code>float violence_confidence = 22 [deprecated = true];</code> + + The user-provided name for this ProductSet. Must not be empty. Must be at +most 4096 characters long. + Generated from protobuf field <code>string display_name = 2;</code> - + type="string"/> - - setViolenceConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setViolenceConfidence() + + setDisplayName + \Google\Cloud\Vision\V1\ProductSet::setDisplayName() - + var - float + string - - Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means -very confident. - Generated from protobuf field <code>float violence_confidence = 22 [deprecated = true];</code> + + The user-provided name for this ProductSet. Must not be empty. Must be at +most 4096 characters long. + Generated from protobuf field <code>string display_name = 2;</code> + variable="var" type="string"/> - - - getRacyConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getRacyConfidence() + + getIndexTime + \Google\Cloud\Vision\V1\ProductSet::getIndexTime() - - Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very -confident. - Generated from protobuf field <code>float racy_confidence = 24 [deprecated = true];</code> + + Output only. The time at which this ProductSet was last indexed. Query +results will reflect all updates before this time. If this ProductSet has +never been indexed, this timestamp is the default value +"1970-01-01T00:00:00Z". + This field is ignored when creating a ProductSet. + +Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> - + type="\Google\Protobuf\Timestamp|null"/> - - setRacyConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setRacyConfidence() + + hasIndexTime + \Google\Cloud\Vision\V1\ProductSet::hasIndexTime() - + + + + + + + + + clearIndexTime + \Google\Cloud\Vision\V1\ProductSet::clearIndexTime() + + + + + + + + + + setIndexTime + \Google\Cloud\Vision\V1\ProductSet::setIndexTime() + + var - float + \Google\Protobuf\Timestamp - - Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very -confident. - Generated from protobuf field <code>float racy_confidence = 24 [deprecated = true];</code> + + Output only. The time at which this ProductSet was last indexed. Query +results will reflect all updates before this time. If this ProductSet has +never been indexed, this timestamp is the default value +"1970-01-01T00:00:00Z". + This field is ignored when creating a ProductSet. + +Generated from protobuf field <code>.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + variable="var" type="\Google\Protobuf\Timestamp"/> - - - getNsfwConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::getNsfwConfidence() + + getIndexError + \Google\Cloud\Vision\V1\ProductSet::getIndexError() - - Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very -confident. - Generated from protobuf field <code>float nsfw_confidence = 26 [deprecated = true];</code> + + Output only. If there was an error with indexing the product set, the field +is populated. + This field is ignored when creating a ProductSet. + +Generated from protobuf field <code>.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> - + type="\Google\Rpc\Status|null"/> - - setNsfwConfidence - \Google\Cloud\Vision\V1\SafeSearchAnnotation::setNsfwConfidence() + + hasIndexError + \Google\Cloud\Vision\V1\ProductSet::hasIndexError() + + + + + + + + + + clearIndexError + \Google\Cloud\Vision\V1\ProductSet::clearIndexError() + + + + + + + + + + setIndexError + \Google\Cloud\Vision\V1\ProductSet::setIndexError() - + var - float + \Google\Rpc\Status - - Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very -confident. - Generated from protobuf field <code>float nsfw_confidence = 26 [deprecated = true];</code> + + Output only. If there was an error with indexing the product set, the field +is populated. + This field is ignored when creating a ProductSet. + +Generated from protobuf field <code>.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> + variable="var" type="\Google\Rpc\Status"/> - @@ -36746,7 +22595,7 @@ confident. - + @@ -36764,12 +22613,13 @@ confident. + - Symbol - \Google\Cloud\Vision\V1\Symbol + ProductSetPurgeConfig + \Google\Cloud\Vision\V1\ProductSetPurgeConfig - A single symbol representation. - Generated from protobuf message <code>google.cloud.vision.v1.Symbol</code> + Config to control which ProductSet contains the Products to be deleted. + Generated from protobuf message <code>google.cloud.vision.v1.ProductSetPurgeConfig</code> \Google\Protobuf\Internal\Message - - property - \Google\Cloud\Vision\V1\Symbol::$property - null - - Additional information detected for the symbol. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - - - - - bounding_box - \Google\Cloud\Vision\V1\Symbol::$bounding_box - null - - The bounding box for the symbol. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: - * when the text is horizontal it might look like: - 0----1 - | | - 3----2 - * when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> - - - - - - text - \Google\Cloud\Vision\V1\Symbol::$text + + product_set_id + \Google\Cloud\Vision\V1\ProductSetPurgeConfig::$product_set_id '' - - The actual UTF-8 representation of the symbol. - Generated from protobuf field <code>string text = 3;</code> - - - - - - confidence - \Google\Cloud\Vision\V1\Symbol::$confidence - 0.0 - - Confidence of the OCR results for the symbol. Range [0, 1]. - Generated from protobuf field <code>float confidence = 4;</code> + + The ProductSet that contains the Products to delete. If a Product is a +member of product_set_id in addition to other ProductSets, the Product will +still be deleted. + Generated from protobuf field <code>string product_set_id = 1;</code> - + __construct - \Google\Cloud\Vision\V1\Symbol::__construct() + \Google\Cloud\Vision\V1\ProductSetPurgeConfig::__construct() - + data - NULL + null array - - Constructor. - - - - - - - - getProperty - \Google\Cloud\Vision\V1\Symbol::getProperty() - - - Additional information detected for the symbol. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - - - - - - hasProperty - \Google\Cloud\Vision\V1\Symbol::hasProperty() - - - + + Constructor. - + + - - clearProperty - \Google\Cloud\Vision\V1\Symbol::clearProperty() + + getProductSetId + \Google\Cloud\Vision\V1\ProductSetPurgeConfig::getProductSetId() - - - - + + The ProductSet that contains the Products to delete. If a Product is a +member of product_set_id in addition to other ProductSets, the Product will +still be deleted. + Generated from protobuf field <code>string product_set_id = 1;</code> + + - - setProperty - \Google\Cloud\Vision\V1\Symbol::setProperty() + + setProductSetId + \Google\Cloud\Vision\V1\ProductSetPurgeConfig::setProductSetId() - + var - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty + string - - Additional information detected for the symbol. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + The ProductSet that contains the Products to delete. If a Product is a +member of product_set_id in addition to other ProductSets, the Product will +still be deleted. + Generated from protobuf field <code>string product_set_id = 1;</code> + variable="var" type="string"/> - - getBoundingBox - \Google\Cloud\Vision\V1\Symbol::getBoundingBox() - - - The bounding box for the symbol. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: - * when the text is horizontal it might look like: - 0----1 - | | - 3----2 - * when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). + + + + + + + + + + + + -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + + + + + + + + + + + Property + \Google\Cloud\Vision\V1\Property + + A `Property` consists of a user-supplied name/value pair. + Generated from protobuf message <code>google.cloud.vision.v1.Property</code> + name="package" + description="Application" + /> - + \Google\Protobuf\Internal\Message + + + + name + \Google\Cloud\Vision\V1\Property::$name + '' + + Name of the property. + Generated from protobuf field <code>string name = 1;</code> + - - hasBoundingBox - \Google\Cloud\Vision\V1\Symbol::hasBoundingBox() + + + + value + \Google\Cloud\Vision\V1\Property::$value + '' + + Value of the property. + Generated from protobuf field <code>string value = 2;</code> + + + + + + uint64_value + \Google\Cloud\Vision\V1\Property::$uint64_value + 0 + + Value of numeric properties. + Generated from protobuf field <code>uint64 uint64_value = 3;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\Property::__construct() - - + + data + null + array + + + + Constructor. - + + - - clearBoundingBox - \Google\Cloud\Vision\V1\Symbol::clearBoundingBox() + + getName + \Google\Cloud\Vision\V1\Property::getName() - - - - + + Name of the property. + Generated from protobuf field <code>string name = 1;</code> + + - - setBoundingBox - \Google\Cloud\Vision\V1\Symbol::setBoundingBox() + + setName + \Google\Cloud\Vision\V1\Property::setName() - + var - \Google\Cloud\Vision\V1\BoundingPoly + string - - The bounding box for the symbol. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: - * when the text is horizontal it might look like: - 0----1 - | | - 3----2 - * when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + + Name of the property. + Generated from protobuf field <code>string name = 1;</code> + variable="var" type="string"/> - - getText - \Google\Cloud\Vision\V1\Symbol::getText() + + getValue + \Google\Cloud\Vision\V1\Property::getValue() - - The actual UTF-8 representation of the symbol. - Generated from protobuf field <code>string text = 3;</code> + + Value of the property. + Generated from protobuf field <code>string value = 2;</code> - - setText - \Google\Cloud\Vision\V1\Symbol::setText() + + setValue + \Google\Cloud\Vision\V1\Property::setValue() - + var string - - The actual UTF-8 representation of the symbol. - Generated from protobuf field <code>string text = 3;</code> + + Value of the property. + Generated from protobuf field <code>string value = 2;</code> - - getConfidence - \Google\Cloud\Vision\V1\Symbol::getConfidence() + + getUint64Value + \Google\Cloud\Vision\V1\Property::getUint64Value() - - Confidence of the OCR results for the symbol. Range [0, 1]. - Generated from protobuf field <code>float confidence = 4;</code> + + Value of numeric properties. + Generated from protobuf field <code>uint64 uint64_value = 3;</code> + type="int|string"/> - - - - setConfidence - \Google\Cloud\Vision\V1\Symbol::setConfidence() + + + + setUint64Value + \Google\Cloud\Vision\V1\Property::setUint64Value() - + var - float + int|string - - Confidence of the OCR results for the symbol. Range [0, 1]. - Generated from protobuf field <code>float confidence = 4;</code> + + Value of numeric properties. + Generated from protobuf field <code>uint64 uint64_value = 3;</code> + variable="var" type="int|string"/> - + @@ -37112,99 +22941,58 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - + - - BreakType - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType - - Enum to denote the type of break found. New line, space etc. - Protobuf type <code>google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType</code> + + + PurgeProductsRequest + \Google\Cloud\Vision\V1\PurgeProductsRequest + + Request message for the `PurgeProducts` method. + Generated from protobuf message <code>google.cloud.vision.v1.PurgeProductsRequest</code> + \Google\Protobuf\Internal\Message - - - UNKNOWN - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::UNKNOWN - 0 - - Unknown break label type. - Generated from protobuf enum <code>UNKNOWN = 0;</code> - - - - - - SPACE - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::SPACE - 1 - - Regular space. - Generated from protobuf enum <code>SPACE = 1;</code> - - - - - - SURE_SPACE - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::SURE_SPACE - 2 - - Sure space (very wide). - Generated from protobuf enum <code>SURE_SPACE = 2;</code> - - - - - - EOL_SURE_SPACE - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::EOL_SURE_SPACE - 3 - - Line-wrapping break. - Generated from protobuf enum <code>EOL_SURE_SPACE = 3;</code> - - - + + + parent + \Google\Cloud\Vision\V1\PurgeProductsRequest::$parent + '' + + Required. The project and location in which the Products should be deleted. + Format is `projects/PROJECT_ID/locations/LOC_ID`. - - HYPHEN - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::HYPHEN - 4 - - End-line hyphen that is not present in text; does not co-occur with -`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`. - Generated from protobuf enum <code>HYPHEN = 4;</code> - +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + - + - - LINE_BREAK - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::LINE_BREAK - 5 - - Line break that ends a paragraph. - Generated from protobuf enum <code>LINE_BREAK = 5;</code> - + + force + \Google\Cloud\Vision\V1\PurgeProductsRequest::$force + false + + The default value is false. Override this value to true to actually perform +the purge. + Generated from protobuf field <code>bool force = 4;</code> + - + - - - valueToName - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::$valueToName - [self::UNKNOWN => 'UNKNOWN', self::SPACE => 'SPACE', self::SURE_SPACE => 'SURE_SPACE', self::EOL_SURE_SPACE => 'EOL_SURE_SPACE', self::HYPHEN => 'HYPHEN', self::LINE_BREAK => 'LINE_BREAK'] - + + target + \Google\Cloud\Vision\V1\PurgeProductsRequest::$target + + @@ -37212,155 +23000,196 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - - name - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::name() + + build + \Google\Cloud\Vision\V1\PurgeProductsRequest::build() - - value + + parent - mixed + string - + - + + + + - - value - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::value() + + __construct + \Google\Cloud\Vision\V1\PurgeProductsRequest::__construct() - - name - - mixed + + data + null + array - - + + Constructor. - + + - - - - - - - - + + getProductSetPurgeConfig + \Google\Cloud\Vision\V1\PurgeProductsRequest::getProductSetPurgeConfig() + + + Specify which ProductSet contains the Products to be deleted. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;</code> + + + + + + + hasProductSetPurgeConfig + \Google\Cloud\Vision\V1\PurgeProductsRequest::hasProductSetPurgeConfig() + + - - + + - - - + + setProductSetPurgeConfig + \Google\Cloud\Vision\V1\PurgeProductsRequest::setProductSetPurgeConfig() + + + var + + \Google\Cloud\Vision\V1\ProductSetPurgeConfig + - - - - - DetectedBreak - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak - - Detected start or end of a structural component. - Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotation.DetectedBreak</code> + + Specify which ProductSet contains the Products to be deleted. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSetPurgeConfig product_set_purge_config = 2;</code> + name="param" + description="" + variable="var" type="\Google\Cloud\Vision\V1\ProductSetPurgeConfig"/> + - \Google\Protobuf\Internal\Message - - - - type - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::$type - 0 - - Detected break type. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType type = 1;</code> - + + + + getDeleteOrphanProducts + \Google\Cloud\Vision\V1\PurgeProductsRequest::getDeleteOrphanProducts() + + + If delete_orphan_products is true, all Products that are not in any +ProductSet will be deleted. + Generated from protobuf field <code>bool delete_orphan_products = 3;</code> + + - + - - is_prefix - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::$is_prefix - false - - True if break prepends the element. - Generated from protobuf field <code>bool is_prefix = 2;</code> - + + hasDeleteOrphanProducts + \Google\Cloud\Vision\V1\PurgeProductsRequest::hasDeleteOrphanProducts() + + + + + - + - - - __construct - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::__construct() + + setDeleteOrphanProducts + \Google\Cloud\Vision\V1\PurgeProductsRequest::setDeleteOrphanProducts() - - data - NULL - array + + var + + bool - - Constructor. - + + If delete_orphan_products is true, all Products that are not in any +ProductSet will be deleted. + Generated from protobuf field <code>bool delete_orphan_products = 3;</code> + description="" + variable="var" type="bool"/> + - - getType - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::getType() + + getParent + \Google\Cloud\Vision\V1\PurgeProductsRequest::getParent() - - Detected break type. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType type = 1;</code> + + Required. The project and location in which the Products should be deleted. + Format is `projects/PROJECT_ID/locations/LOC_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + type="string"/> - - setType - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::setType() + + setParent + \Google\Cloud\Vision\V1\PurgeProductsRequest::setParent() - + var - int + string - - Detected break type. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType type = 1;</code> + + Required. The project and location in which the Products should be deleted. + Format is `projects/PROJECT_ID/locations/LOC_ID`. + +Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + variable="var" type="string"/> - - getIsPrefix - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::getIsPrefix() + + getForce + \Google\Cloud\Vision\V1\PurgeProductsRequest::getForce() - - True if break prepends the element. - Generated from protobuf field <code>bool is_prefix = 2;</code> + + The default value is false. Override this value to true to actually perform +the purge. + Generated from protobuf field <code>bool force = 4;</code> - - setIsPrefix - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::setIsPrefix() + + setForce + \Google\Cloud\Vision\V1\PurgeProductsRequest::setForce() - + var bool - - True if break prepends the element. - Generated from protobuf field <code>bool is_prefix = 2;</code> + + The default value is false. Override this value to true to actually perform +the purge. + Generated from protobuf field <code>bool force = 4;</code> + + + + getTarget + \Google\Cloud\Vision\V1\PurgeProductsRequest::getTarget() + + + + + + + @@ -37415,7 +23261,7 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - + @@ -37427,18 +23273,20 @@ Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly b - + - - DetectedLanguage - \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage - - Detected language for a structural component. - Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotation.DetectedLanguage</code> + + + ReferenceImage + \Google\Cloud\Vision\V1\ReferenceImage + + A `ReferenceImage` represents a product image and its associated metadata, +such as bounding boxes. + Generated from protobuf message <code>google.cloud.vision.v1.ReferenceImage</code> \Google\Protobuf\Internal\Message - - language_code - \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::$language_code + + name + \Google\Cloud\Vision\V1\ReferenceImage::$name '' - - The BCP-47 language code, such as "en-US" or "sr-Latn". For more -information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - Generated from protobuf field <code>string language_code = 1;</code> + + The resource name of the reference image. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. +This field is ignored when creating a reference image. + +Generated from protobuf field <code>string name = 1;</code> - - confidence - \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::$confidence - 0.0 - - Confidence of detected language. Range [0, 1]. - Generated from protobuf field <code>float confidence = 2;</code> + + uri + \Google\Cloud\Vision\V1\ReferenceImage::$uri + '' + + Required. The Google Cloud Storage URI of the reference image. + The URI must start with `gs://`. + +Generated from protobuf field <code>string uri = 2 [(.google.api.field_behavior) = REQUIRED];</code> + + + + + + bounding_polys + \Google\Cloud\Vision\V1\ReferenceImage::$bounding_polys + + + Optional. Bounding polygons around the areas of interest in the reference +image. If this field is empty, the system will try to detect regions of +interest. At most 10 bounding polygons will be used. + The provided shape is converted into a non-rotated rectangle. Once +converted, the small edge of the rectangle must be greater than or equal +to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 +is not). + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];</code> - + __construct - \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::__construct() + \Google\Cloud\Vision\V1\ReferenceImage::__construct() - + data - NULL + null array - + Constructor. - - getLanguageCode - \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::getLanguageCode() + + getName + \Google\Cloud\Vision\V1\ReferenceImage::getName() + + + The resource name of the reference image. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. +This field is ignored when creating a reference image. + +Generated from protobuf field <code>string name = 1;</code> + + + + + + + setName + \Google\Cloud\Vision\V1\ReferenceImage::setName() + + + var + + string + + + + The resource name of the reference image. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. +This field is ignored when creating a reference image. + +Generated from protobuf field <code>string name = 1;</code> + + + + + + + + getUri + \Google\Cloud\Vision\V1\ReferenceImage::getUri() - - The BCP-47 language code, such as "en-US" or "sr-Latn". For more -information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - Generated from protobuf field <code>string language_code = 1;</code> + + Required. The Google Cloud Storage URI of the reference image. + The URI must start with `gs://`. + +Generated from protobuf field <code>string uri = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - setLanguageCode - \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::setLanguageCode() + + setUri + \Google\Cloud\Vision\V1\ReferenceImage::setUri() - + var string - - The BCP-47 language code, such as "en-US" or "sr-Latn". For more -information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - Generated from protobuf field <code>string language_code = 1;</code> + + Required. The Google Cloud Storage URI of the reference image. + The URI must start with `gs://`. + +Generated from protobuf field <code>string uri = 2 [(.google.api.field_behavior) = REQUIRED];</code> - - getConfidence - \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::getConfidence() + + getBoundingPolys + \Google\Cloud\Vision\V1\ReferenceImage::getBoundingPolys() - - Confidence of detected language. Range [0, 1]. - Generated from protobuf field <code>float confidence = 2;</code> + + Optional. Bounding polygons around the areas of interest in the reference +image. If this field is empty, the system will try to detect regions of +interest. At most 10 bounding polygons will be used. + The provided shape is converted into a non-rotated rectangle. Once +converted, the small edge of the rectangle must be greater than or equal +to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 +is not). + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\BoundingPoly>"/> - - setConfidence - \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::setConfidence() + + setBoundingPolys + \Google\Cloud\Vision\V1\ReferenceImage::setBoundingPolys() - + var - float + \Google\Cloud\Vision\V1\BoundingPoly[] - - Confidence of detected language. Range [0, 1]. - Generated from protobuf field <code>float confidence = 2;</code> + + Optional. Bounding polygons around the areas of interest in the reference +image. If this field is empty, the system will try to detect regions of +interest. At most 10 bounding polygons will be used. + The provided shape is converted into a non-rotated rectangle. Once +converted, the small edge of the rectangle must be greater than or equal +to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 +is not). + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];</code> + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly[]"/> - + @@ -37596,18 +23528,19 @@ http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - + - - TextProperty - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty + + + RemoveProductFromProductSetRequest + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest - Additional information detected on the structural component. - Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotation.TextProperty</code> + Request message for the `RemoveProductFromProductSet` method. + Generated from protobuf message <code>google.cloud.vision.v1.RemoveProductFromProductSetRequest</code> \Google\Protobuf\Internal\Message - - detected_languages - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::$detected_languages - - - A list of detected languages together with confidence. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.TextAnnotation.DetectedLanguage detected_languages = 1;</code> + + name + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::$name + '' + + Required. The resource name for the ProductSet to modify. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - - detected_break - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::$detected_break - null - - Detected start or end of a text segment. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak detected_break = 2;</code> + + product + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::$product + '' + + Required. The resource name for the Product to be removed from this +ProductSet. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + +Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> - + + build + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::build() + + + name + + string + + + + product + + string + + + + + + + + + + + + + + __construct - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::__construct() + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::__construct() - + data - NULL + null array - + Constructor. - - getDetectedLanguages - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::getDetectedLanguages() + + getName + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::getName() - - A list of detected languages together with confidence. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.TextAnnotation.DetectedLanguage detected_languages = 1;</code> + + Required. The resource name for the ProductSet to modify. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + type="string"/> - - setDetectedLanguages - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::setDetectedLanguages() + + setName + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::setName() - + var - \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage[]|\Google\Protobuf\Internal\RepeatedField + string - - A list of detected languages together with confidence. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.TextAnnotation.DetectedLanguage detected_languages = 1;</code> + + Required. The resource name for the ProductSet to modify. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + +Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + + + getProduct + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::getProduct() + + + Required. The resource name for the Product to be removed from this +ProductSet. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + +Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + + + + + + + setProduct + \Google\Cloud\Vision\V1\RemoveProductFromProductSetRequest::setProduct() + + + var + + string + + + + Required. The resource name for the Product to be removed from this +ProductSet. + Format is: +`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + +Generated from protobuf field <code>string product = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code> + variable="var" type="string"/> - - getDetectedBreak - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::getDetectedBreak() - - - Detected start or end of a text segment. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak detected_break = 2;</code> + + + + + + + + + + - + name="package" + description="Application" + /> + - - - hasDetectedBreak - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::hasDetectedBreak() - - + + + + + + + + + + + + + + - + + - - - clearDetectedBreak - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::clearDetectedBreak() - - + + + + + + + + + + + + + + - + + - - - setDetectedBreak - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::setDetectedBreak() - - - var - - \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak - + + - - Detected start or end of a text segment. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak detected_break = 2;</code> + + + + + + + + + + + + + - - + name="package" + description="Application" + /> + - - + + + + + + + - + @@ -37787,20 +23850,15 @@ http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - - TextAnnotation - \Google\Cloud\Vision\V1\TextAnnotation - - TextAnnotation contains a structured representation of OCR extracted text. - The hierarchy of an OCR extracted text structure is like this: - TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol -Each structural component, starting from Page, may further have their own -properties. Properties describe detected languages, breaks etc.. Please refer -to the -[TextAnnotation.TextProperty][google.cloud.vision.v1.TextAnnotation.TextProperty] -message definition below for more detail. - -Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotation</code> + + + SafeSearchAnnotation + \Google\Cloud\Vision\V1\SafeSearchAnnotation + + Set of features pertaining to the image, computed by computer vision +methods over safe-search verticals (for example, adult, spoof, medical, +violence). + Generated from protobuf message <code>google.cloud.vision.v1.SafeSearchAnnotation</code> \Google\Protobuf\Internal\Message - - pages - \Google\Cloud\Vision\V1\TextAnnotation::$pages - - - List of pages detected by OCR. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Page pages = 1;</code> + + adult + \Google\Cloud\Vision\V1\SafeSearchAnnotation::$adult + 0 + + Represents the adult content likelihood for the image. Adult content may +contain elements such as nudity, pornographic images or cartoons, or +sexual activities. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood adult = 1;</code> - - text - \Google\Cloud\Vision\V1\TextAnnotation::$text - '' - - UTF-8 text detected on the pages. - Generated from protobuf field <code>string text = 2;</code> + + spoof + \Google\Cloud\Vision\V1\SafeSearchAnnotation::$spoof + 0 + + Spoof likelihood. The likelihood that an modification +was made to the image's canonical version to make it appear +funny or offensive. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood spoof = 2;</code> + + + + + + medical + \Google\Cloud\Vision\V1\SafeSearchAnnotation::$medical + 0 + + Likelihood that this is a medical image. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood medical = 3;</code> + + + + + + violence + \Google\Cloud\Vision\V1\SafeSearchAnnotation::$violence + 0 + + Likelihood that this image contains violent content. Violent content may +include death, serious harm, or injury to individuals or groups of +individuals. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood violence = 4;</code> + + + + + + racy + \Google\Cloud\Vision\V1\SafeSearchAnnotation::$racy + 0 + + Likelihood that the request image contains racy content. Racy content may +include (but is not limited to) skimpy or sheer clothing, strategically +covered nudity, lewd or provocative poses, or close-ups of sensitive +body areas. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood racy = 9;</code> - + __construct - \Google\Cloud\Vision\V1\TextAnnotation::__construct() + \Google\Cloud\Vision\V1\SafeSearchAnnotation::__construct() - + data - NULL + null array - + Constructor. + description="{ Optional. Data for populating the Message object. @type int $adult Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. @type int $spoof Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. @type int $medical Likelihood that this is a medical image. @type int $violence Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals. @type int $racy Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. }" + variable="data" type="array"/> + + + + + + getAdult + \Google\Cloud\Vision\V1\SafeSearchAnnotation::getAdult() + + + Represents the adult content likelihood for the image. Adult content may +contain elements such as nudity, pornographic images or cartoons, or +sexual activities. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood adult = 1;</code> + + + + + + + setAdult + \Google\Cloud\Vision\V1\SafeSearchAnnotation::setAdult() + + + var + + int + + + + Represents the adult content likelihood for the image. Adult content may +contain elements such as nudity, pornographic images or cartoons, or +sexual activities. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood adult = 1;</code> + + - - getPages - \Google\Cloud\Vision\V1\TextAnnotation::getPages() + + getSpoof + \Google\Cloud\Vision\V1\SafeSearchAnnotation::getSpoof() - - List of pages detected by OCR. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Page pages = 1;</code> + + Spoof likelihood. The likelihood that an modification +was made to the image's canonical version to make it appear +funny or offensive. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood spoof = 2;</code> + type="int"/> - - setPages - \Google\Cloud\Vision\V1\TextAnnotation::setPages() + + setSpoof + \Google\Cloud\Vision\V1\SafeSearchAnnotation::setSpoof() - + var - \Google\Cloud\Vision\V1\Page[]|\Google\Protobuf\Internal\RepeatedField + int - - List of pages detected by OCR. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.Page pages = 1;</code> + + Spoof likelihood. The likelihood that an modification +was made to the image's canonical version to make it appear +funny or offensive. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood spoof = 2;</code> + variable="var" type="int"/> - - getText - \Google\Cloud\Vision\V1\TextAnnotation::getText() + + getMedical + \Google\Cloud\Vision\V1\SafeSearchAnnotation::getMedical() - - UTF-8 text detected on the pages. - Generated from protobuf field <code>string text = 2;</code> + + Likelihood that this is a medical image. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood medical = 3;</code> + type="int"/> - - setText - \Google\Cloud\Vision\V1\TextAnnotation::setText() + + setMedical + \Google\Cloud\Vision\V1\SafeSearchAnnotation::setMedical() - + var - string + int - - UTF-8 text detected on the pages. - Generated from protobuf field <code>string text = 2;</code> + + Likelihood that this is a medical image. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood medical = 3;</code> + variable="var" type="int"/> - - - - - - - - - - - - - - - - - - - - - - - TextAnnotation_DetectedBreak - \Google\Cloud\Vision\V1\TextAnnotation_DetectedBreak - - This class is deprecated. Use Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak instead. - + + getViolence + \Google\Cloud\Vision\V1\SafeSearchAnnotation::getViolence() + + + Likelihood that this image contains violent content. Violent content may +include death, serious harm, or injury to individuals or groups of +individuals. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood violence = 4;</code> - + type="int"/> - - - - - - - - - - - - - - - - - + - - - + + setViolence + \Google\Cloud\Vision\V1\SafeSearchAnnotation::setViolence() + + + var + + int + - - - - - TextAnnotation_DetectedBreak_BreakType - \Google\Cloud\Vision\V1\TextAnnotation_DetectedBreak_BreakType - - This class is deprecated. Use Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType instead. - + + Likelihood that this image contains violent content. Violent content may +include death, serious harm, or injury to individuals or groups of +individuals. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood violence = 4;</code> + variable="var" type="int"/> + name="return" + description="" + type="$this"/> - - - - - - - - - - - - - - - - - - - - - + - - - - - TextAnnotation_DetectedLanguage - \Google\Cloud\Vision\V1\TextAnnotation_DetectedLanguage - - This class is deprecated. Use Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage instead. - + + getRacy + \Google\Cloud\Vision\V1\SafeSearchAnnotation::getRacy() + + + Likelihood that the request image contains racy content. Racy content may +include (but is not limited to) skimpy or sheer clothing, strategically +covered nudity, lewd or provocative poses, or close-ups of sensitive +body areas. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood racy = 9;</code> - + type="int"/> - - - - - - - - - - - - - - - - - + - - - + + setRacy + \Google\Cloud\Vision\V1\SafeSearchAnnotation::setRacy() + + + var + + int + - - - - - TextAnnotation_TextProperty - \Google\Cloud\Vision\V1\TextAnnotation_TextProperty - - This class is deprecated. Use Google\Cloud\Vision\V1\TextAnnotation\TextProperty instead. - + + Likelihood that the request image contains racy content. Racy content may +include (but is not limited to) skimpy or sheer clothing, strategically +covered nudity, lewd or provocative poses, or close-ups of sensitive +body areas. + Generated from protobuf field <code>.google.cloud.vision.v1.Likelihood racy = 9;</code> + variable="var" type="int"/> + name="return" + description="" + type="$this"/> - - - - + + - + @@ -38134,13 +24196,13 @@ Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotatio - - TextDetectionParams - \Google\Cloud\Vision\V1\TextDetectionParams - - Parameters for text detections. This is used to control TEXT_DETECTION and -DOCUMENT_TEXT_DETECTION features. - Generated from protobuf message <code>google.cloud.vision.v1.TextDetectionParams</code> + + + Symbol + \Google\Cloud\Vision\V1\Symbol + + A single symbol representation. + Generated from protobuf message <code>google.cloud.vision.v1.Symbol</code> \Google\Protobuf\Internal\Message - - enable_text_detection_confidence_score - \Google\Cloud\Vision\V1\TextDetectionParams::$enable_text_detection_confidence_score - false - - By default, Cloud Vision API only includes confidence score for -DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence -score for TEXT_DETECTION as well. - Generated from protobuf field <code>bool enable_text_detection_confidence_score = 9;</code> + + property + \Google\Cloud\Vision\V1\Symbol::$property + null + + Additional information detected for the symbol. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - advanced_ocr_options - \Google\Cloud\Vision\V1\TextDetectionParams::$advanced_ocr_options - - - A list of advanced OCR options to further fine-tune OCR behavior. - Current valid values are: -- `legacy_layout`: a heuristics layout detection algorithm, which serves as -an alternative to the current ML-based layout detection algorithm. -Customers can choose the best suitable layout algorithm based on their -situation. + + bounding_box + \Google\Cloud\Vision\V1\Symbol::$bounding_box + null + + The bounding box for the symbol. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: + * when the text is horizontal it might look like: + 0----1 + | | + 3----2 + * when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). -Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + + + + + + text + \Google\Cloud\Vision\V1\Symbol::$text + '' + + The actual UTF-8 representation of the symbol. + Generated from protobuf field <code>string text = 3;</code> + + + + + + confidence + \Google\Cloud\Vision\V1\Symbol::$confidence + 0.0 + + Confidence of the OCR results for the symbol. Range [0, 1]. + Generated from protobuf field <code>float confidence = 4;</code> - + __construct - \Google\Cloud\Vision\V1\TextDetectionParams::__construct() + \Google\Cloud\Vision\V1\Symbol::__construct() - + data - NULL + null array - - Constructor. - + + Constructor. + + + + + + + + getProperty + \Google\Cloud\Vision\V1\Symbol::getProperty() + + + Additional information detected for the symbol. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + + + + + + hasProperty + \Google\Cloud\Vision\V1\Symbol::hasProperty() + + + + + + + + + + clearProperty + \Google\Cloud\Vision\V1\Symbol::clearProperty() + + + + + + + + + + setProperty + \Google\Cloud\Vision\V1\Symbol::setProperty() + + + var + + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty + + + + Additional information detected for the symbol. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + + + + + + + getBoundingBox + \Google\Cloud\Vision\V1\Symbol::getBoundingBox() + + + The bounding box for the symbol. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: + * when the text is horizontal it might look like: + 0----1 + | | + 3----2 + * when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + + + + + + + hasBoundingBox + \Google\Cloud\Vision\V1\Symbol::hasBoundingBox() + + + + + + + + + + clearBoundingBox + \Google\Cloud\Vision\V1\Symbol::clearBoundingBox() + + + + + + + + + + setBoundingBox + \Google\Cloud\Vision\V1\Symbol::setBoundingBox() + + + var + + \Google\Cloud\Vision\V1\BoundingPoly + + + + The bounding box for the symbol. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: + * when the text is horizontal it might look like: + 0----1 + | | + 3----2 + * when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). + +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + description="" + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> + - - getEnableTextDetectionConfidenceScore - \Google\Cloud\Vision\V1\TextDetectionParams::getEnableTextDetectionConfidenceScore() + + getText + \Google\Cloud\Vision\V1\Symbol::getText() - - By default, Cloud Vision API only includes confidence score for -DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence -score for TEXT_DETECTION as well. - Generated from protobuf field <code>bool enable_text_detection_confidence_score = 9;</code> + + The actual UTF-8 representation of the symbol. + Generated from protobuf field <code>string text = 3;</code> + type="string"/> - - setEnableTextDetectionConfidenceScore - \Google\Cloud\Vision\V1\TextDetectionParams::setEnableTextDetectionConfidenceScore() + + setText + \Google\Cloud\Vision\V1\Symbol::setText() - + var - bool + string - - By default, Cloud Vision API only includes confidence score for -DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence -score for TEXT_DETECTION as well. - Generated from protobuf field <code>bool enable_text_detection_confidence_score = 9;</code> + + The actual UTF-8 representation of the symbol. + Generated from protobuf field <code>string text = 3;</code> + variable="var" type="string"/> - - getAdvancedOcrOptions - \Google\Cloud\Vision\V1\TextDetectionParams::getAdvancedOcrOptions() + + getConfidence + \Google\Cloud\Vision\V1\Symbol::getConfidence() - - A list of advanced OCR options to further fine-tune OCR behavior. - Current valid values are: -- `legacy_layout`: a heuristics layout detection algorithm, which serves as -an alternative to the current ML-based layout detection algorithm. -Customers can choose the best suitable layout algorithm based on their -situation. - -Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> + + Confidence of the OCR results for the symbol. Range [0, 1]. + Generated from protobuf field <code>float confidence = 4;</code> + type="float"/> - - setAdvancedOcrOptions - \Google\Cloud\Vision\V1\TextDetectionParams::setAdvancedOcrOptions() + + setConfidence + \Google\Cloud\Vision\V1\Symbol::setConfidence() - + var - string[]|\Google\Protobuf\Internal\RepeatedField + float - - A list of advanced OCR options to further fine-tune OCR behavior. - Current valid values are: -- `legacy_layout`: a heuristics layout detection algorithm, which serves as -an alternative to the current ML-based layout detection algorithm. -Customers can choose the best suitable layout algorithm based on their -situation. - -Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> + + Confidence of the OCR results for the symbol. Range [0, 1]. + Generated from protobuf field <code>float confidence = 4;</code> + variable="var" type="float"/> - + @@ -38316,175 +24545,257 @@ Generated from protobuf field <code>repeated string advanced_ocr_options = - + - - UpdateProductRequest - \Google\Cloud\Vision\V1\UpdateProductRequest - - Request message for the `UpdateProduct` method. - Generated from protobuf message <code>google.cloud.vision.v1.UpdateProductRequest</code> + + + BreakType + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType + + Enum to denote the type of break found. New line, space etc. + Protobuf type <code>google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType</code> - \Google\Protobuf\Internal\Message - - - product - \Google\Cloud\Vision\V1\UpdateProductRequest::$product - null - - Required. The Product resource which replaces the one on the server. - product.name is immutable. + + + UNKNOWN + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::UNKNOWN + 0 + + Unknown break label type. + Generated from protobuf enum <code>UNKNOWN = 0;</code> + -Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + + + SPACE + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::SPACE + 1 + + Regular space. + Generated from protobuf enum <code>SPACE = 1;</code> - + - - update_mask - \Google\Cloud\Vision\V1\UpdateProductRequest::$update_mask - null - - The [FieldMask][google.protobuf.FieldMask] that specifies which fields -to update. - If update_mask isn't specified, all mutable fields are to be updated. -Valid mask paths include `product_labels`, `display_name`, and -`description`. + + SURE_SPACE + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::SURE_SPACE + 2 + + Sure space (very wide). + Generated from protobuf enum <code>SURE_SPACE = 2;</code> + -Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> + + + + EOL_SURE_SPACE + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::EOL_SURE_SPACE + 3 + + Line-wrapping break. + Generated from protobuf enum <code>EOL_SURE_SPACE = 3;</code> + + + + + + HYPHEN + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::HYPHEN + 4 + + End-line hyphen that is not present in text; does not co-occur with +`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`. + Generated from protobuf enum <code>HYPHEN = 4;</code> + + + + + + LINE_BREAK + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::LINE_BREAK + 5 + + Line break that ends a paragraph. + Generated from protobuf enum <code>LINE_BREAK = 5;</code> + + + + + + + valueToName + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::$valueToName + [self::UNKNOWN => 'UNKNOWN', self::SPACE => 'SPACE', self::SURE_SPACE => 'SURE_SPACE', self::EOL_SURE_SPACE => 'EOL_SURE_SPACE', self::HYPHEN => 'HYPHEN', self::LINE_BREAK => 'LINE_BREAK'] + + + - - build - \Google\Cloud\Vision\V1\UpdateProductRequest::build() + + name + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::name() - - product + + value - \Google\Cloud\Vision\V1\Product + mixed - - updateMask + + + + + + + + + value + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak\BreakType::value() + + + name - \Google\Protobuf\FieldMask + mixed - + + + + + + + + + + + + + + + - - - + + + + + + + + + + + + + DetectedBreak + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak + + Detected start or end of a structural component. + Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotation.DetectedBreak</code> + - + \Google\Protobuf\Internal\Message + + + + type + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::$type + 0 + + Detected break type. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType type = 1;</code> + - + + + + is_prefix + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::$is_prefix + false + + True if break prepends the element. + Generated from protobuf field <code>bool is_prefix = 2;</code> + + + + + + __construct - \Google\Cloud\Vision\V1\UpdateProductRequest::__construct() + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::__construct() - + data - NULL + null array - + Constructor. - - getProduct - \Google\Cloud\Vision\V1\UpdateProductRequest::getProduct() + + getType + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::getType() - - Required. The Product resource which replaces the one on the server. - product.name is immutable. - -Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + Detected break type. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType type = 1;</code> + type="int"/> - - hasProduct - \Google\Cloud\Vision\V1\UpdateProductRequest::hasProduct() - - - - - - - - - - clearProduct - \Google\Cloud\Vision\V1\UpdateProductRequest::clearProduct() - - - - - - - - - - setProduct - \Google\Cloud\Vision\V1\UpdateProductRequest::setProduct() + + setType + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::setType() - + var - \Google\Cloud\Vision\V1\Product + int - - Required. The Product resource which replaces the one on the server. - product.name is immutable. - -Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + Detected break type. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType type = 1;</code> + variable="var" type="int"/> - - getUpdateMask - \Google\Cloud\Vision\V1\UpdateProductRequest::getUpdateMask() + + getIsPrefix + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::getIsPrefix() - - The [FieldMask][google.protobuf.FieldMask] that specifies which fields -to update. - If update_mask isn't specified, all mutable fields are to be updated. -Valid mask paths include `product_labels`, `display_name`, and -`description`. - -Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> + + True if break prepends the element. + Generated from protobuf field <code>bool is_prefix = 2;</code> + type="bool"/> - - hasUpdateMask - \Google\Cloud\Vision\V1\UpdateProductRequest::hasUpdateMask() - - - - - - - - - - clearUpdateMask - \Google\Cloud\Vision\V1\UpdateProductRequest::clearUpdateMask() - - - - - - - - - - setUpdateMask - \Google\Cloud\Vision\V1\UpdateProductRequest::setUpdateMask() + + setIsPrefix + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak::setIsPrefix() - + var - \Google\Protobuf\FieldMask + bool - - The [FieldMask][google.protobuf.FieldMask] that specifies which fields -to update. - If update_mask isn't specified, all mutable fields are to be updated. -Valid mask paths include `product_labels`, `display_name`, and -`description`. - -Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> + + True if break prepends the element. + Generated from protobuf field <code>bool is_prefix = 2;</code> + variable="var" type="bool"/> - + @@ -38583,168 +24862,110 @@ Generated from protobuf field <code>.google.protobuf.FieldMask update_mask - + - - UpdateProductSetRequest - \Google\Cloud\Vision\V1\UpdateProductSetRequest - - Request message for the `UpdateProductSet` method. - Generated from protobuf message <code>google.cloud.vision.v1.UpdateProductSetRequest</code> - - - - \Google\Protobuf\Internal\Message - - - - product_set - \Google\Cloud\Vision\V1\UpdateProductSetRequest::$product_set - null - - Required. The ProductSet resource which replaces the one on the server. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - - - - - update_mask - \Google\Cloud\Vision\V1\UpdateProductSetRequest::$update_mask - null - - The [FieldMask][google.protobuf.FieldMask] that specifies which fields to -update. - If update_mask isn't specified, all mutable fields are to be updated. -Valid mask path is `display_name`. - -Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> - - - - - - - build - \Google\Cloud\Vision\V1\UpdateProductSetRequest::build() - - - productSet - - \Google\Cloud\Vision\V1\ProductSet - - - - updateMask - - \Google\Protobuf\FieldMask - - - - - - - - - + DetectedLanguage + \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage + + Detected language for a structural component. + Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotation.DetectedLanguage</code> + - + \Google\Protobuf\Internal\Message + + + + language_code + \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::$language_code + '' + + The BCP-47 language code, such as "en-US" or "sr-Latn". For more +information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + Generated from protobuf field <code>string language_code = 1;</code> + - + + + + confidence + \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::$confidence + 0.0 + + Confidence of detected language. Range [0, 1]. + Generated from protobuf field <code>float confidence = 2;</code> + + + + + + __construct - \Google\Cloud\Vision\V1\UpdateProductSetRequest::__construct() + \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::__construct() - + data - NULL + null array - + Constructor. - - getProductSet - \Google\Cloud\Vision\V1\UpdateProductSetRequest::getProductSet() + + getLanguageCode + \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::getLanguageCode() - - Required. The ProductSet resource which replaces the one on the server. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + The BCP-47 language code, such as "en-US" or "sr-Latn". For more +information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + Generated from protobuf field <code>string language_code = 1;</code> + type="string"/> - - hasProductSet - \Google\Cloud\Vision\V1\UpdateProductSetRequest::hasProductSet() - - - - - - - - - - clearProductSet - \Google\Cloud\Vision\V1\UpdateProductSetRequest::clearProductSet() - - - - - - - - - - setProductSet - \Google\Cloud\Vision\V1\UpdateProductSetRequest::setProductSet() + + setLanguageCode + \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::setLanguageCode() - + var - \Google\Cloud\Vision\V1\ProductSet + string - - Required. The ProductSet resource which replaces the one on the server. - Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 1 [(.google.api.field_behavior) = REQUIRED];</code> + + The BCP-47 language code, such as "en-US" or "sr-Latn". For more +information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + Generated from protobuf field <code>string language_code = 1;</code> + variable="var" type="string"/> - - getUpdateMask - \Google\Cloud\Vision\V1\UpdateProductSetRequest::getUpdateMask() + + getConfidence + \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::getConfidence() - - The [FieldMask][google.protobuf.FieldMask] that specifies which fields to -update. - If update_mask isn't specified, all mutable fields are to be updated. -Valid mask path is `display_name`. - -Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> + + Confidence of detected language. Range [0, 1]. + Generated from protobuf field <code>float confidence = 2;</code> + type="float"/> - - hasUpdateMask - \Google\Cloud\Vision\V1\UpdateProductSetRequest::hasUpdateMask() - - - - - - - - - - clearUpdateMask - \Google\Cloud\Vision\V1\UpdateProductSetRequest::clearUpdateMask() - - - - - - - - - - setUpdateMask - \Google\Cloud\Vision\V1\UpdateProductSetRequest::setUpdateMask() + + setConfidence + \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage::setConfidence() - + var - \Google\Protobuf\FieldMask + float - - The [FieldMask][google.protobuf.FieldMask] that specifies which fields to -update. - If update_mask isn't specified, all mutable fields are to be updated. -Valid mask path is `display_name`. - -Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> + + Confidence of detected language. Range [0, 1]. + Generated from protobuf field <code>float confidence = 2;</code> + variable="var" type="float"/> - + @@ -38841,20 +25032,19 @@ Generated from protobuf field <code>.google.protobuf.FieldMask update_mask - + - - Vertex - \Google\Cloud\Vision\V1\Vertex - - A vertex represents a 2D point in the image. - NOTE: the vertex coordinates are in the same scale as the original image. - -Generated from protobuf message <code>google.cloud.vision.v1.Vertex</code> + + + TextProperty + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty + + Additional information detected on the structural component. + Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotation.TextProperty</code> \Google\Protobuf\Internal\Message - - x - \Google\Cloud\Vision\V1\Vertex::$x - 0 - - X coordinate. - Generated from protobuf field <code>int32 x = 1;</code> + + detected_languages + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::$detected_languages + + + A list of detected languages together with confidence. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.TextAnnotation.DetectedLanguage detected_languages = 1;</code> - - y - \Google\Cloud\Vision\V1\Vertex::$y - 0 - - Y coordinate. - Generated from protobuf field <code>int32 y = 2;</code> + + detected_break + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::$detected_break + null + + Detected start or end of a text segment. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak detected_break = 2;</code> - + __construct - \Google\Cloud\Vision\V1\Vertex::__construct() + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::__construct() - + data - NULL + null array - + Constructor. - - getX - \Google\Cloud\Vision\V1\Vertex::getX() + + getDetectedLanguages + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::getDetectedLanguages() - - X coordinate. - Generated from protobuf field <code>int32 x = 1;</code> + + A list of detected languages together with confidence. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.TextAnnotation.DetectedLanguage detected_languages = 1;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage>"/> - - setX - \Google\Cloud\Vision\V1\Vertex::setX() + + setDetectedLanguages + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::setDetectedLanguages() - + var - int + \Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage[] - - X coordinate. - Generated from protobuf field <code>int32 x = 1;</code> + + A list of detected languages together with confidence. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.TextAnnotation.DetectedLanguage detected_languages = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\TextAnnotation\DetectedLanguage[]"/> - - getY - \Google\Cloud\Vision\V1\Vertex::getY() + + getDetectedBreak + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::getDetectedBreak() - - Y coordinate. - Generated from protobuf field <code>int32 y = 2;</code> + + Detected start or end of a text segment. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak detected_break = 2;</code> + type="\Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak|null"/> - - setY - \Google\Cloud\Vision\V1\Vertex::setY() + + hasDetectedBreak + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::hasDetectedBreak() - + + + + + + + + + clearDetectedBreak + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::clearDetectedBreak() + + + + + + + + + + setDetectedBreak + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty::setDetectedBreak() + + var - int + \Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak - - Y coordinate. - Generated from protobuf field <code>int32 y = 2;</code> + + Detected start or end of a text segment. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.DetectedBreak detected_break = 2;</code> + variable="var" type="\Google\Cloud\Vision\V1\TextAnnotation\DetectedBreak"/> - + @@ -39006,18 +25218,27 @@ Generated from protobuf message <code>google.cloud.vision.v1.Vertex</co - + - - WebEntity - \Google\Cloud\Vision\V1\WebDetection\WebEntity - - Entity deduced from similar images on the Internet. - Generated from protobuf message <code>google.cloud.vision.v1.WebDetection.WebEntity</code> + + + TextAnnotation + \Google\Cloud\Vision\V1\TextAnnotation + + TextAnnotation contains a structured representation of OCR extracted text. + The hierarchy of an OCR extracted text structure is like this: + TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol +Each structural component, starting from Page, may further have their own +properties. Properties describe detected languages, breaks etc.. Please refer +to the +[TextAnnotation.TextProperty][google.cloud.vision.v1.TextAnnotation.TextProperty] +message definition below for more detail. + +Generated from protobuf message <code>google.cloud.vision.v1.TextAnnotation</code> \Google\Protobuf\Internal\Message - - entity_id - \Google\Cloud\Vision\V1\WebDetection\WebEntity::$entity_id - '' - - Opaque entity ID. - Generated from protobuf field <code>string entity_id = 1;</code> - - - - - - score - \Google\Cloud\Vision\V1\WebDetection\WebEntity::$score - 0.0 + + pages + \Google\Cloud\Vision\V1\TextAnnotation::$pages + - Overall relevancy score for the entity. - Not normalized and not comparable across different image queries. - -Generated from protobuf field <code>float score = 2;</code> + List of pages detected by OCR. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Page pages = 1;</code> - - description - \Google\Cloud\Vision\V1\WebDetection\WebEntity::$description + + text + \Google\Cloud\Vision\V1\TextAnnotation::$text '' - Canonical description of the entity, in English. - Generated from protobuf field <code>string description = 3;</code> + UTF-8 text detected on the pages. + Generated from protobuf field <code>string text = 2;</code> - + __construct - \Google\Cloud\Vision\V1\WebDetection\WebEntity::__construct() + \Google\Cloud\Vision\V1\TextAnnotation::__construct() - + data - NULL + null array - + Constructor. - - getEntityId - \Google\Cloud\Vision\V1\WebDetection\WebEntity::getEntityId() - - - Opaque entity ID. - Generated from protobuf field <code>string entity_id = 1;</code> - - - - - - - setEntityId - \Google\Cloud\Vision\V1\WebDetection\WebEntity::setEntityId() - - - var - - string - - - - Opaque entity ID. - Generated from protobuf field <code>string entity_id = 1;</code> - - - - - - - - getScore - \Google\Cloud\Vision\V1\WebDetection\WebEntity::getScore() + + getPages + \Google\Cloud\Vision\V1\TextAnnotation::getPages() - - Overall relevancy score for the entity. - Not normalized and not comparable across different image queries. - -Generated from protobuf field <code>float score = 2;</code> + + List of pages detected by OCR. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Page pages = 1;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Page>"/> - - setScore - \Google\Cloud\Vision\V1\WebDetection\WebEntity::setScore() + + setPages + \Google\Cloud\Vision\V1\TextAnnotation::setPages() - + var - float + \Google\Cloud\Vision\V1\Page[] - - Overall relevancy score for the entity. - Not normalized and not comparable across different image queries. - -Generated from protobuf field <code>float score = 2;</code> + + List of pages detected by OCR. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.Page pages = 1;</code> + variable="var" type="\Google\Cloud\Vision\V1\Page[]"/> - - getDescription - \Google\Cloud\Vision\V1\WebDetection\WebEntity::getDescription() + + getText + \Google\Cloud\Vision\V1\TextAnnotation::getText() - - Canonical description of the entity, in English. - Generated from protobuf field <code>string description = 3;</code> + + UTF-8 text detected on the pages. + Generated from protobuf field <code>string text = 2;</code> - - setDescription - \Google\Cloud\Vision\V1\WebDetection\WebEntity::setDescription() + + setText + \Google\Cloud\Vision\V1\TextAnnotation::setText() - + var string - - Canonical description of the entity, in English. - Generated from protobuf field <code>string description = 3;</code> + + UTF-8 text detected on the pages. + Generated from protobuf field <code>string text = 2;</code> - + @@ -39226,18 +25390,20 @@ Generated from protobuf field <code>float score = 2;</code> + - - WebImage - \Google\Cloud\Vision\V1\WebDetection\WebImage - - Metadata for online images. - Generated from protobuf message <code>google.cloud.vision.v1.WebDetection.WebImage</code> + + + TextDetectionParams + \Google\Cloud\Vision\V1\TextDetectionParams + + Parameters for text detections. This is used to control TEXT_DETECTION and +DOCUMENT_TEXT_DETECTION features. + Generated from protobuf message <code>google.cloud.vision.v1.TextDetectionParams</code> \Google\Protobuf\Internal\Message - - url - \Google\Cloud\Vision\V1\WebDetection\WebImage::$url - '' - - The result image URL. - Generated from protobuf field <code>string url = 1;</code> + + enable_text_detection_confidence_score + \Google\Cloud\Vision\V1\TextDetectionParams::$enable_text_detection_confidence_score + false + + By default, Cloud Vision API only includes confidence score for +DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence +score for TEXT_DETECTION as well. + Generated from protobuf field <code>bool enable_text_detection_confidence_score = 9;</code> - - score - \Google\Cloud\Vision\V1\WebDetection\WebImage::$score - 0.0 - - (Deprecated) Overall relevancy score for the image. - Generated from protobuf field <code>float score = 2;</code> + + advanced_ocr_options + \Google\Cloud\Vision\V1\TextDetectionParams::$advanced_ocr_options + + + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: +- `legacy_layout`: a heuristics layout detection algorithm, which serves as +an alternative to the current ML-based layout detection algorithm. +Customers can choose the best suitable layout algorithm based on their +situation. + +Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> - + __construct - \Google\Cloud\Vision\V1\WebDetection\WebImage::__construct() + \Google\Cloud\Vision\V1\TextDetectionParams::__construct() - + data - NULL + null array - + Constructor. - - getUrl - \Google\Cloud\Vision\V1\WebDetection\WebImage::getUrl() + + getEnableTextDetectionConfidenceScore + \Google\Cloud\Vision\V1\TextDetectionParams::getEnableTextDetectionConfidenceScore() - - The result image URL. - Generated from protobuf field <code>string url = 1;</code> + + By default, Cloud Vision API only includes confidence score for +DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence +score for TEXT_DETECTION as well. + Generated from protobuf field <code>bool enable_text_detection_confidence_score = 9;</code> + type="bool"/> - - setUrl - \Google\Cloud\Vision\V1\WebDetection\WebImage::setUrl() + + setEnableTextDetectionConfidenceScore + \Google\Cloud\Vision\V1\TextDetectionParams::setEnableTextDetectionConfidenceScore() - + var - string + bool - - The result image URL. - Generated from protobuf field <code>string url = 1;</code> + + By default, Cloud Vision API only includes confidence score for +DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence +score for TEXT_DETECTION as well. + Generated from protobuf field <code>bool enable_text_detection_confidence_score = 9;</code> + variable="var" type="bool"/> - - getScore - \Google\Cloud\Vision\V1\WebDetection\WebImage::getScore() + + getAdvancedOcrOptions + \Google\Cloud\Vision\V1\TextDetectionParams::getAdvancedOcrOptions() - - (Deprecated) Overall relevancy score for the image. - Generated from protobuf field <code>float score = 2;</code> + + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: +- `legacy_layout`: a heuristics layout detection algorithm, which serves as +an alternative to the current ML-based layout detection algorithm. +Customers can choose the best suitable layout algorithm based on their +situation. + +Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> + type="\Google\Protobuf\RepeatedField<string>"/> - - setScore - \Google\Cloud\Vision\V1\WebDetection\WebImage::setScore() + + setAdvancedOcrOptions + \Google\Cloud\Vision\V1\TextDetectionParams::setAdvancedOcrOptions() - + var - float + string[] - - (Deprecated) Overall relevancy score for the image. - Generated from protobuf field <code>float score = 2;</code> + + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: +- `legacy_layout`: a heuristics layout detection algorithm, which serves as +an alternative to the current ML-based layout detection algorithm. +Customers can choose the best suitable layout algorithm based on their +situation. + +Generated from protobuf field <code>repeated string advanced_ocr_options = 11;</code> + variable="var" type="string[]"/> - + @@ -39389,18 +25579,19 @@ Generated from protobuf field <code>float score = 2;</code> + - - WebLabel - \Google\Cloud\Vision\V1\WebDetection\WebLabel + + + UpdateProductRequest + \Google\Cloud\Vision\V1\UpdateProductRequest - Label to provide extra metadata for the web detection. - Generated from protobuf message <code>google.cloud.vision.v1.WebDetection.WebLabel</code> + Request message for the `UpdateProduct` method. + Generated from protobuf message <code>google.cloud.vision.v1.UpdateProductRequest</code> \Google\Protobuf\Internal\Message - - label - \Google\Cloud\Vision\V1\WebDetection\WebLabel::$label - '' - - Label for extra metadata. - Generated from protobuf field <code>string label = 1;</code> + + product + \Google\Cloud\Vision\V1\UpdateProductRequest::$product + null + + Required. The Product resource which replaces the one on the server. + product.name is immutable. + +Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - language_code - \Google\Cloud\Vision\V1\WebDetection\WebLabel::$language_code - '' - - The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - For more information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + + update_mask + \Google\Cloud\Vision\V1\UpdateProductRequest::$update_mask + null + + The [FieldMask][google.protobuf.FieldMask] that specifies which fields +to update. + If update_mask isn't specified, all mutable fields are to be updated. +Valid mask paths include `product_labels`, `display_name`, and +`description`. -Generated from protobuf field <code>string language_code = 2;</code> +Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> - + + build + \Google\Cloud\Vision\V1\UpdateProductRequest::build() + + + product + + \Google\Cloud\Vision\V1\Product + + + + updateMask + + \Google\Protobuf\FieldMask + + + + + + + + + + + + + + __construct - \Google\Cloud\Vision\V1\WebDetection\WebLabel::__construct() + \Google\Cloud\Vision\V1\UpdateProductRequest::__construct() - + data - NULL + null array - + Constructor. - - getLabel - \Google\Cloud\Vision\V1\WebDetection\WebLabel::getLabel() + + getProduct + \Google\Cloud\Vision\V1\UpdateProductRequest::getProduct() - - Label for extra metadata. - Generated from protobuf field <code>string label = 1;</code> + + Required. The Product resource which replaces the one on the server. + product.name is immutable. + +Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1 [(.google.api.field_behavior) = REQUIRED];</code> + type="\Google\Cloud\Vision\V1\Product|null"/> - - setLabel - \Google\Cloud\Vision\V1\WebDetection\WebLabel::setLabel() + + hasProduct + \Google\Cloud\Vision\V1\UpdateProductRequest::hasProduct() - + + + + + + + + + clearProduct + \Google\Cloud\Vision\V1\UpdateProductRequest::clearProduct() + + + + + + + + + + setProduct + \Google\Cloud\Vision\V1\UpdateProductRequest::setProduct() + + var - string + \Google\Cloud\Vision\V1\Product - - Label for extra metadata. - Generated from protobuf field <code>string label = 1;</code> + + Required. The Product resource which replaces the one on the server. + product.name is immutable. + +Generated from protobuf field <code>.google.cloud.vision.v1.Product product = 1 [(.google.api.field_behavior) = REQUIRED];</code> + variable="var" type="\Google\Cloud\Vision\V1\Product"/> + type="$this"/> + + + + + + getUpdateMask + \Google\Cloud\Vision\V1\UpdateProductRequest::getUpdateMask() + + + The [FieldMask][google.protobuf.FieldMask] that specifies which fields +to update. + If update_mask isn't specified, all mutable fields are to be updated. +Valid mask paths include `product_labels`, `display_name`, and +`description`. + +Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> + - - getLanguageCode - \Google\Cloud\Vision\V1\WebDetection\WebLabel::getLanguageCode() + + hasUpdateMask + \Google\Cloud\Vision\V1\UpdateProductRequest::hasUpdateMask() - - The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - For more information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + + + + -Generated from protobuf field <code>string language_code = 2;</code> - - + + + + clearUpdateMask + \Google\Cloud\Vision\V1\UpdateProductRequest::clearUpdateMask() + + + + + - - setLanguageCode - \Google\Cloud\Vision\V1\WebDetection\WebLabel::setLanguageCode() + + setUpdateMask + \Google\Cloud\Vision\V1\UpdateProductRequest::setUpdateMask() - + var - string + \Google\Protobuf\FieldMask - - The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - For more information, see -http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + + The [FieldMask][google.protobuf.FieldMask] that specifies which fields +to update. + If update_mask isn't specified, all mutable fields are to be updated. +Valid mask paths include `product_labels`, `display_name`, and +`description`. -Generated from protobuf field <code>string language_code = 2;</code> +Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> + variable="var" type="\Google\Protobuf\FieldMask"/> - + @@ -39561,18 +25847,19 @@ Generated from protobuf field <code>string language_code = 2;</code> - + - - WebPage - \Google\Cloud\Vision\V1\WebDetection\WebPage + + + UpdateProductSetRequest + \Google\Cloud\Vision\V1\UpdateProductSetRequest - Metadata for web pages. - Generated from protobuf message <code>google.cloud.vision.v1.WebDetection.WebPage</code> + Request message for the `UpdateProductSet` method. + Generated from protobuf message <code>google.cloud.vision.v1.UpdateProductSetRequest</code> \Google\Protobuf\Internal\Message - - url - \Google\Cloud\Vision\V1\WebDetection\WebPage::$url - '' + + product_set + \Google\Cloud\Vision\V1\UpdateProductSetRequest::$product_set + null - The result web page URL. - Generated from protobuf field <code>string url = 1;</code> + Required. The ProductSet resource which replaces the one on the server. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 1 [(.google.api.field_behavior) = REQUIRED];</code> - - score - \Google\Cloud\Vision\V1\WebDetection\WebPage::$score - 0.0 - - (Deprecated) Overall relevancy score for the web page. - Generated from protobuf field <code>float score = 2;</code> - - - + + update_mask + \Google\Cloud\Vision\V1\UpdateProductSetRequest::$update_mask + null + + The [FieldMask][google.protobuf.FieldMask] that specifies which fields to +update. + If update_mask isn't specified, all mutable fields are to be updated. +Valid mask path is `display_name`. - - page_title - \Google\Cloud\Vision\V1\WebDetection\WebPage::$page_title - '' - - Title for the web page, may contain HTML markups. - Generated from protobuf field <code>string page_title = 3;</code> +Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> - - full_matching_images - \Google\Cloud\Vision\V1\WebDetection\WebPage::$full_matching_images + + + build + \Google\Cloud\Vision\V1\UpdateProductSetRequest::build() + + + productSet - - Fully matching images on the page. - Can include resized copies of the query image. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 4;</code> - - - + \Google\Cloud\Vision\V1\ProductSet + - - partial_matching_images - \Google\Cloud\Vision\V1\WebDetection\WebPage::$partial_matching_images + + updateMask - - Partial matching images on the page. - Those images are similar enough to share some key-point features. For -example an original image will likely have partial matching for its -crops. + \Google\Protobuf\FieldMask + -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 5;</code> - + + + + + + + + - + - - + __construct - \Google\Cloud\Vision\V1\WebDetection\WebPage::__construct() + \Google\Cloud\Vision\V1\UpdateProductSetRequest::__construct() - + data - NULL + null array - + Constructor. - - getUrl - \Google\Cloud\Vision\V1\WebDetection\WebPage::getUrl() + + getProductSet + \Google\Cloud\Vision\V1\UpdateProductSetRequest::getProductSet() - - The result web page URL. - Generated from protobuf field <code>string url = 1;</code> + + Required. The ProductSet resource which replaces the one on the server. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 1 [(.google.api.field_behavior) = REQUIRED];</code> + type="\Google\Cloud\Vision\V1\ProductSet|null"/> - - setUrl - \Google\Cloud\Vision\V1\WebDetection\WebPage::setUrl() + + hasProductSet + \Google\Cloud\Vision\V1\UpdateProductSetRequest::hasProductSet() - + + + + + + + + + clearProductSet + \Google\Cloud\Vision\V1\UpdateProductSetRequest::clearProductSet() + + + + + + + + + + setProductSet + \Google\Cloud\Vision\V1\UpdateProductSetRequest::setProductSet() + + var - string + \Google\Cloud\Vision\V1\ProductSet - - The result web page URL. - Generated from protobuf field <code>string url = 1;</code> + + Required. The ProductSet resource which replaces the one on the server. + Generated from protobuf field <code>.google.cloud.vision.v1.ProductSet product_set = 1 [(.google.api.field_behavior) = REQUIRED];</code> + variable="var" type="\Google\Cloud\Vision\V1\ProductSet"/> - - getScore - \Google\Cloud\Vision\V1\WebDetection\WebPage::getScore() + + getUpdateMask + \Google\Cloud\Vision\V1\UpdateProductSetRequest::getUpdateMask() - - (Deprecated) Overall relevancy score for the web page. - Generated from protobuf field <code>float score = 2;</code> + + The [FieldMask][google.protobuf.FieldMask] that specifies which fields to +update. + If update_mask isn't specified, all mutable fields are to be updated. +Valid mask path is `display_name`. + +Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> + type="\Google\Protobuf\FieldMask|null"/> - - setScore - \Google\Cloud\Vision\V1\WebDetection\WebPage::setScore() + + hasUpdateMask + \Google\Cloud\Vision\V1\UpdateProductSetRequest::hasUpdateMask() + + + + + + + + + + clearUpdateMask + \Google\Cloud\Vision\V1\UpdateProductSetRequest::clearUpdateMask() - + + + + + + + + + setUpdateMask + \Google\Cloud\Vision\V1\UpdateProductSetRequest::setUpdateMask() + + var - float + \Google\Protobuf\FieldMask - - (Deprecated) Overall relevancy score for the web page. - Generated from protobuf field <code>float score = 2;</code> + + The [FieldMask][google.protobuf.FieldMask] that specifies which fields to +update. + If update_mask isn't specified, all mutable fields are to be updated. +Valid mask path is `display_name`. + +Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code> + variable="var" type="\Google\Protobuf\FieldMask"/> - - getPageTitle - \Google\Cloud\Vision\V1\WebDetection\WebPage::getPageTitle() - - - Title for the web page, may contain HTML markups. - Generated from protobuf field <code>string page_title = 3;</code> + + + + + + + + + + + name="package" + description="Application" + /> + + + + + + + + + + + + + Vertex + \Google\Cloud\Vision\V1\Vertex + + A vertex represents a 2D point in the image. + NOTE: the vertex coordinates are in the same scale as the original image. + +Generated from protobuf message <code>google.cloud.vision.v1.Vertex</code> + - + \Google\Protobuf\Internal\Message + + + + x + \Google\Cloud\Vision\V1\Vertex::$x + 0 + + X coordinate. + Generated from protobuf field <code>int32 x = 1;</code> + - - setPageTitle - \Google\Cloud\Vision\V1\WebDetection\WebPage::setPageTitle() + + + + y + \Google\Cloud\Vision\V1\Vertex::$y + 0 + + Y coordinate. + Generated from protobuf field <code>int32 y = 2;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\Vertex::__construct() - - var - - string + + data + null + array - - Title for the web page, may contain HTML markups. - Generated from protobuf field <code>string page_title = 3;</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type int $x X coordinate. @type int $y Y coordinate. }" + variable="data" type="array"/> - - getFullMatchingImages - \Google\Cloud\Vision\V1\WebDetection\WebPage::getFullMatchingImages() + + getX + \Google\Cloud\Vision\V1\Vertex::getX() - - Fully matching images on the page. - Can include resized copies of the query image. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 4;</code> + + X coordinate. + Generated from protobuf field <code>int32 x = 1;</code> + type="int"/> - - setFullMatchingImages - \Google\Cloud\Vision\V1\WebDetection\WebPage::setFullMatchingImages() + + setX + \Google\Cloud\Vision\V1\Vertex::setX() - + var - \Google\Cloud\Vision\V1\WebDetection\WebImage[]|\Google\Protobuf\Internal\RepeatedField + int - - Fully matching images on the page. - Can include resized copies of the query image. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 4;</code> + + X coordinate. + Generated from protobuf field <code>int32 x = 1;</code> + variable="var" type="int"/> - - getPartialMatchingImages - \Google\Cloud\Vision\V1\WebDetection\WebPage::getPartialMatchingImages() + + getY + \Google\Cloud\Vision\V1\Vertex::getY() - - Partial matching images on the page. - Those images are similar enough to share some key-point features. For -example an original image will likely have partial matching for its -crops. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 5;</code> + + Y coordinate. + Generated from protobuf field <code>int32 y = 2;</code> + type="int"/> - - setPartialMatchingImages - \Google\Cloud\Vision\V1\WebDetection\WebPage::setPartialMatchingImages() + + setY + \Google\Cloud\Vision\V1\Vertex::setY() - + var - \Google\Cloud\Vision\V1\WebDetection\WebImage[]|\Google\Protobuf\Internal\RepeatedField + int - - Partial matching images on the page. - Those images are similar enough to share some key-point features. For -example an original image will likely have partial matching for its -crops. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 5;</code> + + Y coordinate. + Generated from protobuf field <code>int32 y = 2;</code> + variable="var" type="int"/> - + @@ -39895,154 +26272,117 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDe - + - - WebDetection - \Google\Cloud\Vision\V1\WebDetection + + + WebEntity + \Google\Cloud\Vision\V1\WebDetection\WebEntity - Relevant information for the image from the Internet. - Generated from protobuf message <code>google.cloud.vision.v1.WebDetection</code> + Entity deduced from similar images on the Internet. + Generated from protobuf message <code>google.cloud.vision.v1.WebDetection.WebEntity</code> - - - \Google\Protobuf\Internal\Message - - - - web_entities - \Google\Cloud\Vision\V1\WebDetection::$web_entities - - - Deduced entities from similar images on the Internet. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebEntity web_entities = 1;</code> - - - - - - full_matching_images - \Google\Cloud\Vision\V1\WebDetection::$full_matching_images - - - Fully matching images from the Internet. - Can include resized copies of the query image. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 2;</code> - - - - - - partial_matching_images - \Google\Cloud\Vision\V1\WebDetection::$partial_matching_images - - - Partial matching images from the Internet. - Those images are similar enough to share some key-point features. For -example an original image will likely have partial matching for its crops. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 3;</code> - - - + /> + - - pages_with_matching_images - \Google\Cloud\Vision\V1\WebDetection::$pages_with_matching_images - - - Web pages containing the matching images from the Internet. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebPage pages_with_matching_images = 4;</code> + \Google\Protobuf\Internal\Message + + + + entity_id + \Google\Cloud\Vision\V1\WebDetection\WebEntity::$entity_id + '' + + Opaque entity ID. + Generated from protobuf field <code>string entity_id = 1;</code> - - visually_similar_images - \Google\Cloud\Vision\V1\WebDetection::$visually_similar_images - - - The visually similar image results. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage visually_similar_images = 6;</code> + + score + \Google\Cloud\Vision\V1\WebDetection\WebEntity::$score + 0.0 + + Overall relevancy score for the entity. + Not normalized and not comparable across different image queries. + +Generated from protobuf field <code>float score = 2;</code> - - best_guess_labels - \Google\Cloud\Vision\V1\WebDetection::$best_guess_labels - - - The service's best guess as to the topic of the request image. - Inferred from similar images on the open web. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebLabel best_guess_labels = 8;</code> + + description + \Google\Cloud\Vision\V1\WebDetection\WebEntity::$description + '' + + Canonical description of the entity, in English. + Generated from protobuf field <code>string description = 3;</code> - + __construct - \Google\Cloud\Vision\V1\WebDetection::__construct() + \Google\Cloud\Vision\V1\WebDetection\WebEntity::__construct() - + data - NULL + null array - + Constructor. - - getWebEntities - \Google\Cloud\Vision\V1\WebDetection::getWebEntities() + + getEntityId + \Google\Cloud\Vision\V1\WebDetection\WebEntity::getEntityId() - - Deduced entities from similar images on the Internet. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebEntity web_entities = 1;</code> + + Opaque entity ID. + Generated from protobuf field <code>string entity_id = 1;</code> + type="string"/> - - setWebEntities - \Google\Cloud\Vision\V1\WebDetection::setWebEntities() + + setEntityId + \Google\Cloud\Vision\V1\WebDetection\WebEntity::setEntityId() - + var - \Google\Cloud\Vision\V1\WebDetection\WebEntity[]|\Google\Protobuf\Internal\RepeatedField + string - - Deduced entities from similar images on the Internet. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebEntity web_entities = 1;</code> + + Opaque entity ID. + Generated from protobuf field <code>string entity_id = 1;</code> + variable="var" type="string"/> - - getFullMatchingImages - \Google\Cloud\Vision\V1\WebDetection::getFullMatchingImages() + + getScore + \Google\Cloud\Vision\V1\WebDetection\WebEntity::getScore() - - Fully matching images from the Internet. - Can include resized copies of the query image. + + Overall relevancy score for the entity. + Not normalized and not comparable across different image queries. -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 2;</code> +Generated from protobuf field <code>float score = 2;</code> + type="float"/> - - setFullMatchingImages - \Google\Cloud\Vision\V1\WebDetection::setFullMatchingImages() + + setScore + \Google\Cloud\Vision\V1\WebDetection\WebEntity::setScore() - + var - \Google\Cloud\Vision\V1\WebDetection\WebImage[]|\Google\Protobuf\Internal\RepeatedField + float - - Fully matching images from the Internet. - Can include resized copies of the query image. + + Overall relevancy score for the entity. + Not normalized and not comparable across different image queries. -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 2;</code> +Generated from protobuf field <code>float score = 2;</code> + variable="var" type="float"/> - - getPartialMatchingImages - \Google\Cloud\Vision\V1\WebDetection::getPartialMatchingImages() + + getDescription + \Google\Cloud\Vision\V1\WebDetection\WebEntity::getDescription() - - Partial matching images from the Internet. - Those images are similar enough to share some key-point features. For -example an original image will likely have partial matching for its crops. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 3;</code> + + Canonical description of the entity, in English. + Generated from protobuf field <code>string description = 3;</code> + type="string"/> - - setPartialMatchingImages - \Google\Cloud\Vision\V1\WebDetection::setPartialMatchingImages() + + setDescription + \Google\Cloud\Vision\V1\WebDetection\WebEntity::setDescription() - + var - \Google\Cloud\Vision\V1\WebDetection\WebImage[]|\Google\Protobuf\Internal\RepeatedField + string - - Partial matching images from the Internet. - Those images are similar enough to share some key-point features. For -example an original image will likely have partial matching for its crops. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 3;</code> + + Canonical description of the entity, in English. + Generated from protobuf field <code>string description = 3;</code> + variable="var" type="string"/> - - getPagesWithMatchingImages - \Google\Cloud\Vision\V1\WebDetection::getPagesWithMatchingImages() - - - Web pages containing the matching images from the Internet. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebPage pages_with_matching_images = 4;</code> + + + + + + + + + + + name="package" + description="Application" + /> + + + + + + + + + + + + + WebImage + \Google\Cloud\Vision\V1\WebDetection\WebImage + + Metadata for online images. + Generated from protobuf message <code>google.cloud.vision.v1.WebDetection.WebImage</code> + - + \Google\Protobuf\Internal\Message + + + + url + \Google\Cloud\Vision\V1\WebDetection\WebImage::$url + '' + + The result image URL. + Generated from protobuf field <code>string url = 1;</code> + - - setPagesWithMatchingImages - \Google\Cloud\Vision\V1\WebDetection::setPagesWithMatchingImages() + + + + score + \Google\Cloud\Vision\V1\WebDetection\WebImage::$score + 0.0 + + (Deprecated) Overall relevancy score for the image. + Generated from protobuf field <code>float score = 2;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\WebDetection\WebImage::__construct() - - var - - \Google\Cloud\Vision\V1\WebDetection\WebPage[]|\Google\Protobuf\Internal\RepeatedField + + data + null + array - - Web pages containing the matching images from the Internet. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebPage pages_with_matching_images = 4;</code> + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type string $url The result image URL. @type float $score (Deprecated) Overall relevancy score for the image. }" + variable="data" type="array"/> - - getVisuallySimilarImages - \Google\Cloud\Vision\V1\WebDetection::getVisuallySimilarImages() + + getUrl + \Google\Cloud\Vision\V1\WebDetection\WebImage::getUrl() - - The visually similar image results. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage visually_similar_images = 6;</code> + + The result image URL. + Generated from protobuf field <code>string url = 1;</code> + type="string"/> - - setVisuallySimilarImages - \Google\Cloud\Vision\V1\WebDetection::setVisuallySimilarImages() + + setUrl + \Google\Cloud\Vision\V1\WebDetection\WebImage::setUrl() - + var - \Google\Cloud\Vision\V1\WebDetection\WebImage[]|\Google\Protobuf\Internal\RepeatedField + string - - The visually similar image results. - Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage visually_similar_images = 6;</code> + + The result image URL. + Generated from protobuf field <code>string url = 1;</code> + variable="var" type="string"/> - - getBestGuessLabels - \Google\Cloud\Vision\V1\WebDetection::getBestGuessLabels() + + getScore + \Google\Cloud\Vision\V1\WebDetection\WebImage::getScore() - - The service's best guess as to the topic of the request image. - Inferred from similar images on the open web. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebLabel best_guess_labels = 8;</code> + + (Deprecated) Overall relevancy score for the image. + Generated from protobuf field <code>float score = 2;</code> + type="float"/> - - setBestGuessLabels - \Google\Cloud\Vision\V1\WebDetection::setBestGuessLabels() + + setScore + \Google\Cloud\Vision\V1\WebDetection\WebImage::setScore() - + var - \Google\Cloud\Vision\V1\WebDetection\WebLabel[]|\Google\Protobuf\Internal\RepeatedField + float - - The service's best guess as to the topic of the request image. - Inferred from similar images on the open web. - -Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebLabel best_guess_labels = 8;</code> + + (Deprecated) Overall relevancy score for the image. + Generated from protobuf field <code>float score = 2;</code> + variable="var" type="float"/> - + @@ -40283,171 +26657,168 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDe - + - - WebDetection_WebEntity - \Google\Cloud\Vision\V1\WebDetection_WebEntity - - This class is deprecated. Use Google\Cloud\Vision\V1\WebDetection\WebEntity instead. - + + + WebLabel + \Google\Cloud\Vision\V1\WebDetection\WebLabel + + Label to provide extra metadata for the web detection. + Generated from protobuf message <code>google.cloud.vision.v1.WebDetection.WebLabel</code> - + \Google\Protobuf\Internal\Message - - - - - - - - - - - - - - + + label + \Google\Cloud\Vision\V1\WebDetection\WebLabel::$label + '' + + Label for extra metadata. + Generated from protobuf field <code>string label = 1;</code> + + - - - + + language_code + \Google\Cloud\Vision\V1\WebDetection\WebLabel::$language_code + '' + + The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". + For more information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - - - - - WebDetection_WebImage - \Google\Cloud\Vision\V1\WebDetection_WebImage - - This class is deprecated. Use Google\Cloud\Vision\V1\WebDetection\WebImage instead. +Generated from protobuf field <code>string language_code = 2;</code> + + + + + + + __construct + \Google\Cloud\Vision\V1\WebDetection\WebLabel::__construct() + + + data + null + array + + + + Constructor. - + name="param" + description="{ Optional. Data for populating the Message object. @type string $label Label for extra metadata. @type string $language_code The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. }" + variable="data" type="array"/> - - - - - - - - - - - - - - + + + + getLabel + \Google\Cloud\Vision\V1\WebDetection\WebLabel::getLabel() + + + Label for extra metadata. + Generated from protobuf field <code>string label = 1;</code> - + name="return" + description="" + type="string"/> + + - - - + + setLabel + \Google\Cloud\Vision\V1\WebDetection\WebLabel::setLabel() + + + var + + string + - - - - - WebDetection_WebLabel - \Google\Cloud\Vision\V1\WebDetection_WebLabel - - This class is deprecated. Use Google\Cloud\Vision\V1\WebDetection\WebLabel instead. - + + Label for extra metadata. + Generated from protobuf field <code>string label = 1;</code> + variable="var" type="string"/> + name="return" + description="" + type="$this"/> - - - - - - - - - - - - - - + + + + getLanguageCode + \Google\Cloud\Vision\V1\WebDetection\WebLabel::getLanguageCode() + + + The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". + For more information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + +Generated from protobuf field <code>string language_code = 2;</code> - + name="return" + description="" + type="string"/> + + - - - + + setLanguageCode + \Google\Cloud\Vision\V1\WebDetection\WebLabel::setLanguageCode() + + + var + + string + - - - - - WebDetection_WebPage - \Google\Cloud\Vision\V1\WebDetection_WebPage - - This class is deprecated. Use Google\Cloud\Vision\V1\WebDetection\WebPage instead. - + + The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". + For more information, see +http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + +Generated from protobuf field <code>string language_code = 2;</code> + variable="var" type="string"/> + name="return" + description="" + type="$this"/> - - - - + + - + @@ -40459,18 +26830,19 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDe - + - - WebDetectionParams - \Google\Cloud\Vision\V1\WebDetectionParams + + + WebPage + \Google\Cloud\Vision\V1\WebDetection\WebPage - Parameters for web detection request. - Generated from protobuf message <code>google.cloud.vision.v1.WebDetectionParams</code> + Metadata for web pages. + Generated from protobuf message <code>google.cloud.vision.v1.WebDetection.WebPage</code> \Google\Protobuf\Internal\Message - - include_geo_results - \Google\Cloud\Vision\V1\WebDetectionParams::$include_geo_results - false - - This field has no effect on results. - Generated from protobuf field <code>bool include_geo_results = 2 [deprecated = true];</code> - - + + url + \Google\Cloud\Vision\V1\WebDetection\WebPage::$url + '' + + The result web page URL. + Generated from protobuf field <code>string url = 1;</code> + + + + + + score + \Google\Cloud\Vision\V1\WebDetection\WebPage::$score + 0.0 + + (Deprecated) Overall relevancy score for the web page. + Generated from protobuf field <code>float score = 2;</code> + + + + + + page_title + \Google\Cloud\Vision\V1\WebDetection\WebPage::$page_title + '' + + Title for the web page, may contain HTML markups. + Generated from protobuf field <code>string page_title = 3;</code> + + + + + + full_matching_images + \Google\Cloud\Vision\V1\WebDetection\WebPage::$full_matching_images + + + Fully matching images on the page. + Can include resized copies of the query image. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 4;</code> + + + + + + partial_matching_images + \Google\Cloud\Vision\V1\WebDetection\WebPage::$partial_matching_images + + + Partial matching images on the page. + Those images are similar enough to share some key-point features. For +example an original image will likely have partial matching for its +crops. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 5;</code> + - + __construct - \Google\Cloud\Vision\V1\WebDetectionParams::__construct() + \Google\Cloud\Vision\V1\WebDetection\WebPage::__construct() - + data - NULL + null array - + Constructor. - - getIncludeGeoResults - \Google\Cloud\Vision\V1\WebDetectionParams::getIncludeGeoResults() + + getUrl + \Google\Cloud\Vision\V1\WebDetection\WebPage::getUrl() + + + The result web page URL. + Generated from protobuf field <code>string url = 1;</code> + + + + + + + setUrl + \Google\Cloud\Vision\V1\WebDetection\WebPage::setUrl() + + + var + + string + + + + The result web page URL. + Generated from protobuf field <code>string url = 1;</code> + + + + + + + + getScore + \Google\Cloud\Vision\V1\WebDetection\WebPage::getScore() + + + (Deprecated) Overall relevancy score for the web page. + Generated from protobuf field <code>float score = 2;</code> + + + + + + + setScore + \Google\Cloud\Vision\V1\WebDetection\WebPage::setScore() + + + var + + float + + + + (Deprecated) Overall relevancy score for the web page. + Generated from protobuf field <code>float score = 2;</code> + + + + + + + + getPageTitle + \Google\Cloud\Vision\V1\WebDetection\WebPage::getPageTitle() + + + Title for the web page, may contain HTML markups. + Generated from protobuf field <code>string page_title = 3;</code> + + + + + + + setPageTitle + \Google\Cloud\Vision\V1\WebDetection\WebPage::setPageTitle() + + + var + + string + + + + Title for the web page, may contain HTML markups. + Generated from protobuf field <code>string page_title = 3;</code> + + + + + + + + getFullMatchingImages + \Google\Cloud\Vision\V1\WebDetection\WebPage::getFullMatchingImages() + + + Fully matching images on the page. + Can include resized copies of the query image. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 4;</code> + + + + + + + setFullMatchingImages + \Google\Cloud\Vision\V1\WebDetection\WebPage::setFullMatchingImages() + + + var + + \Google\Cloud\Vision\V1\WebDetection\WebImage[] + + + + Fully matching images on the page. + Can include resized copies of the query image. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 4;</code> + + + + + + + + getPartialMatchingImages + \Google\Cloud\Vision\V1\WebDetection\WebPage::getPartialMatchingImages() - - This field has no effect on results. - Generated from protobuf field <code>bool include_geo_results = 2 [deprecated = true];</code> + + Partial matching images on the page. + Those images are similar enough to share some key-point features. For +example an original image will likely have partial matching for its +crops. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 5;</code> - + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\WebDetection\WebImage>"/> - - setIncludeGeoResults - \Google\Cloud\Vision\V1\WebDetectionParams::setIncludeGeoResults() + + setPartialMatchingImages + \Google\Cloud\Vision\V1\WebDetection\WebPage::setPartialMatchingImages() - + var - bool + \Google\Cloud\Vision\V1\WebDetection\WebImage[] - - This field has no effect on results. - Generated from protobuf field <code>bool include_geo_results = 2 [deprecated = true];</code> + + Partial matching images on the page. + Those images are similar enough to share some key-point features. For +example an original image will likely have partial matching for its +crops. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 5;</code> + variable="var" type="\Google\Cloud\Vision\V1\WebDetection\WebImage[]"/> - @@ -40571,7 +27153,7 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDe - + @@ -40589,12 +27171,13 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDe + - Word - \Google\Cloud\Vision\V1\Word + WebDetection + \Google\Cloud\Vision\V1\WebDetection - A word representation. - Generated from protobuf message <code>google.cloud.vision.v1.Word</code> + Relevant information for the image from the Internet. + Generated from protobuf message <code>google.cloud.vision.v1.WebDetection</code> \Google\Protobuf\Internal\Message - - property - \Google\Cloud\Vision\V1\Word::$property - null + + web_entities + \Google\Cloud\Vision\V1\WebDetection::$web_entities + - Additional information detected for the word. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + Deduced entities from similar images on the Internet. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebEntity web_entities = 1;</code> - - bounding_box - \Google\Cloud\Vision\V1\Word::$bounding_box - null - - The bounding box for the word. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: - * when the text is horizontal it might look like: - 0----1 - | | - 3----2 - * when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). + + full_matching_images + \Google\Cloud\Vision\V1\WebDetection::$full_matching_images + + + Fully matching images from the Internet. + Can include resized copies of the query image. -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 2;</code> - - symbols - \Google\Cloud\Vision\V1\Word::$symbols + + partial_matching_images + \Google\Cloud\Vision\V1\WebDetection::$partial_matching_images - - List of symbols in the word. - The order of the symbols follows the natural reading order. + + Partial matching images from the Internet. + Those images are similar enough to share some key-point features. For +example an original image will likely have partial matching for its crops. -Generated from protobuf field <code>repeated .google.cloud.vision.v1.Symbol symbols = 3;</code> +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 3;</code> - - confidence - \Google\Cloud\Vision\V1\Word::$confidence - 0.0 - - Confidence of the OCR results for the word. Range [0, 1]. - Generated from protobuf field <code>float confidence = 4;</code> + + pages_with_matching_images + \Google\Cloud\Vision\V1\WebDetection::$pages_with_matching_images + + + Web pages containing the matching images from the Internet. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebPage pages_with_matching_images = 4;</code> + + + + + + visually_similar_images + \Google\Cloud\Vision\V1\WebDetection::$visually_similar_images + + + The visually similar image results. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage visually_similar_images = 6;</code> + + + + + + best_guess_labels + \Google\Cloud\Vision\V1\WebDetection::$best_guess_labels + + + The service's best guess as to the topic of the request image. + Inferred from similar images on the open web. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebLabel best_guess_labels = 8;</code> - + __construct - \Google\Cloud\Vision\V1\Word::__construct() + \Google\Cloud\Vision\V1\WebDetection::__construct() - + data - NULL + null array - + Constructor. - - getProperty - \Google\Cloud\Vision\V1\Word::getProperty() + + getWebEntities + \Google\Cloud\Vision\V1\WebDetection::getWebEntities() - - Additional information detected for the word. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + Deduced entities from similar images on the Internet. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebEntity web_entities = 1;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\WebDetection\WebEntity>"/> - - hasProperty - \Google\Cloud\Vision\V1\Word::hasProperty() + + setWebEntities + \Google\Cloud\Vision\V1\WebDetection::setWebEntities() - - - - + + var + + \Google\Cloud\Vision\V1\WebDetection\WebEntity[] + + + + Deduced entities from similar images on the Internet. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebEntity web_entities = 1;</code> + + + - - clearProperty - \Google\Cloud\Vision\V1\Word::clearProperty() + + getFullMatchingImages + \Google\Cloud\Vision\V1\WebDetection::getFullMatchingImages() - - - - + + Fully matching images from the Internet. + Can include resized copies of the query image. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 2;</code> + + + + + + + setFullMatchingImages + \Google\Cloud\Vision\V1\WebDetection::setFullMatchingImages() + + + var + + \Google\Cloud\Vision\V1\WebDetection\WebImage[] + + + + Fully matching images from the Internet. + Can include resized copies of the query image. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage full_matching_images = 2;</code> + + + + + + + + getPartialMatchingImages + \Google\Cloud\Vision\V1\WebDetection::getPartialMatchingImages() + + + Partial matching images from the Internet. + Those images are similar enough to share some key-point features. For +example an original image will likely have partial matching for its crops. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 3;</code> + + - - setProperty - \Google\Cloud\Vision\V1\Word::setProperty() + + setPartialMatchingImages + \Google\Cloud\Vision\V1\WebDetection::setPartialMatchingImages() - + var - \Google\Cloud\Vision\V1\TextAnnotation\TextProperty + \Google\Cloud\Vision\V1\WebDetection\WebImage[] - - Additional information detected for the word. - Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + + Partial matching images from the Internet. + Those images are similar enough to share some key-point features. For +example an original image will likely have partial matching for its crops. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage partial_matching_images = 3;</code> + variable="var" type="\Google\Cloud\Vision\V1\WebDetection\WebImage[]"/> - - getBoundingBox - \Google\Cloud\Vision\V1\Word::getBoundingBox() + + getPagesWithMatchingImages + \Google\Cloud\Vision\V1\WebDetection::getPagesWithMatchingImages() - - The bounding box for the word. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: - * when the text is horizontal it might look like: - 0----1 - | | - 3----2 - * when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + + Web pages containing the matching images from the Internet. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebPage pages_with_matching_images = 4;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\WebDetection\WebPage>"/> - - hasBoundingBox - \Google\Cloud\Vision\V1\Word::hasBoundingBox() + + setPagesWithMatchingImages + \Google\Cloud\Vision\V1\WebDetection::setPagesWithMatchingImages() - - - - + + var + + \Google\Cloud\Vision\V1\WebDetection\WebPage[] + + + + Web pages containing the matching images from the Internet. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebPage pages_with_matching_images = 4;</code> + + + - - clearBoundingBox - \Google\Cloud\Vision\V1\Word::clearBoundingBox() + + getVisuallySimilarImages + \Google\Cloud\Vision\V1\WebDetection::getVisuallySimilarImages() - - - - + + The visually similar image results. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage visually_similar_images = 6;</code> + + - - setBoundingBox - \Google\Cloud\Vision\V1\Word::setBoundingBox() + + setVisuallySimilarImages + \Google\Cloud\Vision\V1\WebDetection::setVisuallySimilarImages() - + var - \Google\Cloud\Vision\V1\BoundingPoly + \Google\Cloud\Vision\V1\WebDetection\WebImage[] - - The bounding box for the word. - The vertices are in the order of top-left, top-right, bottom-right, -bottom-left. When a rotation of the bounding box is detected the rotation -is represented as around the top-left corner as defined when the text is -read in the 'natural' orientation. -For example: - * when the text is horizontal it might look like: - 0----1 - | | - 3----2 - * when it's rotated 180 degrees around the top-left corner it becomes: - 2----3 - | | - 1----0 - and the vertex order will still be (0, 1, 2, 3). - -Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + + The visually similar image results. + Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebImage visually_similar_images = 6;</code> + variable="var" type="\Google\Cloud\Vision\V1\WebDetection\WebImage[]"/> - - getSymbols - \Google\Cloud\Vision\V1\Word::getSymbols() + + getBestGuessLabels + \Google\Cloud\Vision\V1\WebDetection::getBestGuessLabels() - - List of symbols in the word. - The order of the symbols follows the natural reading order. + + The service's best guess as to the topic of the request image. + Inferred from similar images on the open web. -Generated from protobuf field <code>repeated .google.cloud.vision.v1.Symbol symbols = 3;</code> +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebLabel best_guess_labels = 8;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\WebDetection\WebLabel>"/> - - setSymbols - \Google\Cloud\Vision\V1\Word::setSymbols() + + setBestGuessLabels + \Google\Cloud\Vision\V1\WebDetection::setBestGuessLabels() - + var - \Google\Cloud\Vision\V1\Symbol[]|\Google\Protobuf\Internal\RepeatedField + \Google\Cloud\Vision\V1\WebDetection\WebLabel[] - - List of symbols in the word. - The order of the symbols follows the natural reading order. + + The service's best guess as to the topic of the request image. + Inferred from similar images on the open web. -Generated from protobuf field <code>repeated .google.cloud.vision.v1.Symbol symbols = 3;</code> +Generated from protobuf field <code>repeated .google.cloud.vision.v1.WebDetection.WebLabel best_guess_labels = 8;</code> + variable="var" type="\Google\Cloud\Vision\V1\WebDetection\WebLabel[]"/> - - getConfidence - \Google\Cloud\Vision\V1\Word::getConfidence() + + + + + + + + + + + + + + + + + + + + + + + + WebDetectionParams + \Google\Cloud\Vision\V1\WebDetectionParams + + Parameters for web detection request. + Generated from protobuf message <code>google.cloud.vision.v1.WebDetectionParams</code> + + + + \Google\Protobuf\Internal\Message + + + + include_geo_results + \Google\Cloud\Vision\V1\WebDetectionParams::$include_geo_results + false + + This field has no effect on results. + Generated from protobuf field <code>bool include_geo_results = 2 [deprecated = true];</code> + + + + + + + + __construct + \Google\Cloud\Vision\V1\WebDetectionParams::__construct() - - Confidence of the OCR results for the word. Range [0, 1]. - Generated from protobuf field <code>float confidence = 4;</code> + + data + null + array + + + + Constructor. + + + + + + + + getIncludeGeoResults + \Google\Cloud\Vision\V1\WebDetectionParams::getIncludeGeoResults() + + + This field has no effect on results. + Generated from protobuf field <code>bool include_geo_results = 2 [deprecated = true];</code> + type="bool"/> + - - setConfidence - \Google\Cloud\Vision\V1\Word::setConfidence() + + setIncludeGeoResults + \Google\Cloud\Vision\V1\WebDetectionParams::setIncludeGeoResults() - + var - float + bool - - Confidence of the OCR results for the word. Range [0, 1]. - Generated from protobuf field <code>float confidence = 4;</code> + + This field has no effect on results. + Generated from protobuf field <code>bool include_geo_results = 2 [deprecated = true];</code> + variable="var" type="bool"/> + @@ -40931,20 +27667,10 @@ Generated from protobuf field <code>repeated .google.cloud.vision.v1.Symbo - + - Copyright 2016 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + + - + - - VisionClient - \Google\Cloud\Vision\VisionClient - - Google Cloud Vision allows you to understand the content of an image, -classify images into categories, detect text, objects, faces and more. Find -more information at the -[Google Cloud Vision docs](https://cloud.google.com/vision/docs/). - Please note this client will be deprecated in our next release. In order -to receive the latest features and updates, please take -the time to familiarize yourself with {@see \Google\Cloud\Vision\V1\ImageAnnotatorClient}. - -Example: -``` -use Google\Cloud\Vision\VisionClient; - -$vision = new VisionClient(); -``` + + + Word + \Google\Cloud\Vision\V1\Word + + A word representation. + Generated from protobuf message <code>google.cloud.vision.v1.Word</code> - + \Google\Protobuf\Internal\Message - - - VERSION - \Google\Cloud\Vision\VisionClient::VERSION - '1.10.1' - - - - + + + property + \Google\Cloud\Vision\V1\Word::$property + null + + Additional information detected for the word. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + - + - - FULL_CONTROL_SCOPE - \Google\Cloud\Vision\VisionClient::FULL_CONTROL_SCOPE - 'https://www.googleapis.com/auth/cloud-platform' - - - - + + bounding_box + \Google\Cloud\Vision\V1\Word::$bounding_box + null + + The bounding box for the word. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: + * when the text is horizontal it might look like: + 0----1 + | | + 3----2 + * when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). - +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> + - - - connection - \Google\Cloud\Vision\VisionClient::$connection + + + + symbols + \Google\Cloud\Vision\V1\Word::$symbols - - - - - - + + List of symbols in the word. + The order of the symbols follows the natural reading order. + +Generated from protobuf field <code>repeated .google.cloud.vision.v1.Symbol symbols = 3;</code> + + + + + + confidence + \Google\Cloud\Vision\V1\Word::$confidence + 0.0 + + Confidence of the OCR results for the word. Range [0, 1]. + Generated from protobuf field <code>float confidence = 4;</code> + - + __construct - \Google\Cloud\Vision\VisionClient::__construct() + \Google\Cloud\Vision\V1\Word::__construct() - - config - [] + + data + null array - - Create a Vision client. - Note that when creating a VisionClient instance, setting -`$config.projectId` is not supported. To switch between projects, you -must provide credentials with access to the project. + + Constructor. + - + description="{ Optional. Data for populating the Message object. @type \Google\Cloud\Vision\V1\TextAnnotation\TextProperty $property Additional information detected for the word. @type \Google\Cloud\Vision\V1\BoundingPoly $bounding_box The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * * when the text is horizontal it might look like: 0----1 | | 3----2 * * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). @type \Google\Cloud\Vision\V1\Symbol[] $symbols List of symbols in the word. The order of the symbols follows the natural reading order. @type float $confidence Confidence of the OCR results for the word. Range [0, 1]. }" + variable="data" type="array"/> - - image - \Google\Cloud\Vision\VisionClient::image() + + getProperty + \Google\Cloud\Vision\V1\Word::getProperty() - - image - - resource|string|\Google\Cloud\Storage\StorageObject - - - - features - - array - - - - options - [] - array - - - - Create an instance of {@see \Google\Cloud\Vision\Image} with required -features and options. - This method should be used to configure a single image, or when a set of -images requires different settings for each member of the set. If you -have a set of images which all will use the same settings, -{@see \Google\Cloud\Vision\VisionClient::images()} may be quicker and -simpler to use. - -This method will not perform any service requests, and is meant to be -used to configure a request prior to calling -{@see \Google\Cloud\Vision\VisionClient::annotate()}. - -For more information, including best practices and examples detailing -other usage such as `$imageContext`, see {@see \Google\Cloud\Vision\Image::__construct()}. - -Example: -``` -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); - -$image = $vision->image($imageResource, [ - 'FACE_DETECTION' -]); -``` - -``` -// Setting maxResults for a feature - -$imageResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); - -$image = $vision->image($imageResource, [ - 'FACE_DETECTION' -], [ - 'maxResults' => [ - 'FACE_DETECTION' => 1 - ] -]); -``` + + Additional information detected for the word. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> - - - - + type="\Google\Cloud\Vision\V1\TextAnnotation\TextProperty|null"/> - - images - \Google\Cloud\Vision\VisionClient::images() + + hasProperty + \Google\Cloud\Vision\V1\Word::hasProperty() - - images - - resource[]|string[]|\Google\Cloud\Storage\StorageObject[] - + + + + - - features - - array - + - - options - [] - array + + clearProperty + \Google\Cloud\Vision\V1\Word::clearProperty() + + + + + + + + + + setProperty + \Google\Cloud\Vision\V1\Word::setProperty() + + + var + + \Google\Cloud\Vision\V1\TextAnnotation\TextProperty - - Create an array of type {@see \Google\Cloud\Vision\Image} with required features and options -set for each member of the set. - This method is useful for quickly configuring every member of a set of -images with the same features and options. Should you need to provide -different features or options for one or more members of the set, -{@see \Google\Cloud\Vision\VisionClient::image()} is a better choice. - -This method will not perform any service requests, and is meant to be -used to configure a request prior to calling -{@see \Google\Cloud\Vision\VisionClient::annotateBatch()}. - -For more information, including best practices and examples detailing -other usage such as `$imageContext`, see {@see \Google\Cloud\Vision\Image::__construct()}. - -Example: -``` -// In the example below, both images will have the same settings applied. -// They will both run face detection and return up to 10 results. - -$familyPhotoResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$weddingPhotoResource = fopen(__DIR__ . '/assets/wedding-photo.jpg', 'r'); - -$images = $vision->images([$familyPhotoResource, $weddingPhotoResource], [ - 'FACE_DETECTION' -], [ - 'maxResults' => [ - 'FACE_DETECTION' => 10 - ] -]); -``` - - - + Additional information detected for the word. + Generated from protobuf field <code>.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;</code> + - + variable="var" type="\Google\Cloud\Vision\V1\TextAnnotation\TextProperty"/> + type="$this"/> - - annotate - \Google\Cloud\Vision\VisionClient::annotate() + + getBoundingBox + \Google\Cloud\Vision\V1\Word::getBoundingBox() - - image - - \Google\Cloud\Vision\Image - - - - options - [] - array - - - - Annotate a single image. - Example: -``` -$familyPhotoResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); - -$image = $vision->image($familyPhotoResource, [ - 'FACE_DETECTION' -]); + + The bounding box for the word. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: + * when the text is horizontal it might look like: + 0----1 + | | + 3----2 + * when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). -$result = $vision->annotate($image); -``` +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> - - - + type="\Google\Cloud\Vision\V1\BoundingPoly|null"/> - - annotateBatch - \Google\Cloud\Vision\VisionClient::annotateBatch() + + hasBoundingBox + \Google\Cloud\Vision\V1\Word::hasBoundingBox() + + + + + + + + + + clearBoundingBox + \Google\Cloud\Vision\V1\Word::clearBoundingBox() - - images - - \Google\Cloud\Vision\Image[] - - - - options - [] - array - - - - Annotate a set of images. - Example: -``` -$images = []; + + + + -$familyPhotoResource = fopen(__DIR__ . '/assets/family-photo.jpg', 'r'); -$eiffelTowerResource = fopen(__DIR__ . '/assets/eiffel-tower.jpg', 'r'); + -$images[] = $vision->image($familyPhotoResource, [ - 'FACE_DETECTION' -]); + + setBoundingBox + \Google\Cloud\Vision\V1\Word::setBoundingBox() + + + var + + \Google\Cloud\Vision\V1\BoundingPoly + -$images[] = $vision->image($eiffelTowerResource, [ - 'LANDMARK_DETECTION' -]); + + The bounding box for the word. + The vertices are in the order of top-left, top-right, bottom-right, +bottom-left. When a rotation of the bounding box is detected the rotation +is represented as around the top-left corner as defined when the text is +read in the 'natural' orientation. +For example: + * when the text is horizontal it might look like: + 0----1 + | | + 3----2 + * when it's rotated 180 degrees around the top-left corner it becomes: + 2----3 + | | + 1----0 + and the vertex order will still be (0, 1, 2, 3). -$result = $vision->annotateBatch($images); -``` +Generated from protobuf field <code>.google.cloud.vision.v1.BoundingPoly bounding_box = 2;</code> - - + description="" + variable="var" type="\Google\Cloud\Vision\V1\BoundingPoly"/> + type="$this"/> - - - - - - - - - Copyright 2018 Google Inc. All Rights Reserved. - Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - - - - - - - - - - - - - VisionHelpersTrait - \Google\Cloud\Vision\VisionHelpersTrait - - Provides helper methods for generated Vision clients. - - - + + getSymbols + \Google\Cloud\Vision\V1\Word::getSymbols() + + + List of symbols in the word. + The order of the symbols follows the natural reading order. - - urlSchemes - \Google\Cloud\Vision\VisionHelpersTrait::$urlSchemes - ['http', 'https', 'gs'] - - A list of allowed url schemes. - +Generated from protobuf field <code>repeated .google.cloud.vision.v1.Symbol symbols = 3;</code> + type="\Google\Protobuf\RepeatedField<\Google\Cloud\Vision\V1\Symbol>"/> - + - - - annotateImageHelper - \Google\Cloud\Vision\VisionHelpersTrait::annotateImageHelper() + + setSymbols + \Google\Cloud\Vision\V1\Word::setSymbols() - - callback - - callable - - - - requestClass - - \Google\Cloud\Vision\V1\AnnotateImageRequest|mixed - - - - image - - \Google\Cloud\Vision\Image|mixed - - - - features + + var - \Google\Cloud\Vision\V1\Feature[]|int[] + \Google\Cloud\Vision\V1\Symbol[] - - optionalArgs - [] - array - + + List of symbols in the word. + The order of the symbols follows the natural reading order. - - - +Generated from protobuf field <code>repeated .google.cloud.vision.v1.Symbol symbols = 3;</code> - - - - + variable="var" type="\Google\Cloud\Vision\V1\Symbol[]"/> + type="$this"/> - - buildFeatureList - \Google\Cloud\Vision\VisionHelpersTrait::buildFeatureList() + + getConfidence + \Google\Cloud\Vision\V1\Word::getConfidence() - - featureClass - - string - - - - featureTypes - - \Google\Cloud\Vision\V1\Feature[]|int[] - - - - - + + Confidence of the OCR results for the word. Range [0, 1]. + Generated from protobuf field <code>float confidence = 4;</code> - - + type="float"/> - - createImageHelper - \Google\Cloud\Vision\VisionHelpersTrait::createImageHelper() + + setConfidence + \Google\Cloud\Vision\V1\Word::setConfidence() - - imageClass - - string - - - - imageSourceClass - - string - - - - imageInput + + var - string|resource|\Google\Cloud\Vision\Image|mixed + float - - - + + Confidence of the OCR results for the word. Range [0, 1]. + Generated from protobuf field <code>float confidence = 4;</code> - - + variable="var" type="float"/> + type="$this"/> - + + - - - - - - - - - - - - - - - - - - - - - @@ -41572,8 +28043,6 @@ limitations under the License. - - @@ -41589,17 +28058,14 @@ limitations under the License. - - - - - + + @@ -41607,14 +28073,14 @@ limitations under the License. - - + + @@ -41622,16 +28088,17 @@ limitations under the License. - - + + + + + - - @@ -41639,16 +28106,12 @@ limitations under the License. - - - - @@ -41656,19 +28119,17 @@ limitations under the License. - - - - - - + - + + + - + + @@ -41683,8 +28144,6 @@ limitations under the License. - - @@ -41700,25 +28159,10 @@ limitations under the License. - - - - - - - - - - - - - - - @@ -41733,8 +28177,6 @@ limitations under the License. - - @@ -41757,15 +28199,6 @@ limitations under the License. - - - - - - - - - @@ -41780,8 +28213,6 @@ limitations under the License. - - From 354f726ffbd28c069ded6ba13fef53f573e4ff0f Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Mon, 20 Apr 2026 12:29:24 -0700 Subject: [PATCH 2/2] fix docfx tests --- dev/tests/Unit/Command/DocFxCommandTest.php | 4 +- .../docfx/Vision/V1.AnnotateFileRequest.yml | 6 +- .../docfx/Vision/V1.AnnotateFileResponse.yml | 2 +- .../docfx/Vision/V1.AnnotateImageRequest.yml | 2 +- .../docfx/Vision/V1.AnnotateImageResponse.yml | 12 +- .../Vision/V1.AsyncAnnotateFileRequest.yml | 2 +- .../V1.AsyncBatchAnnotateFilesRequest.yml | 2 +- .../V1.AsyncBatchAnnotateFilesResponse.yml | 2 +- .../V1.AsyncBatchAnnotateImagesRequest.yml | 2 +- .../Vision/V1.BatchAnnotateFilesRequest.yml | 2 +- .../Vision/V1.BatchAnnotateFilesResponse.yml | 2 +- .../Vision/V1.BatchAnnotateImagesRequest.yml | 2 +- .../Vision/V1.BatchAnnotateImagesResponse.yml | 2 +- dev/tests/fixtures/docfx/Vision/V1.Block.yml | 2 +- .../fixtures/docfx/Vision/V1.BoundingPoly.yml | 4 +- .../Vision/V1.Client.ImageAnnotatorClient.yml | 22 +- .../Vision/V1.Client.ProductSearchClient.yml | 22 +- .../docfx/Vision/V1.CropHintsAnnotation.yml | 2 +- .../docfx/Vision/V1.CropHintsParams.yml | 4 +- .../Vision/V1.DominantColorsAnnotation.yml | 2 +- .../docfx/Vision/V1.EntityAnnotation.yml | 4 +- .../docfx/Vision/V1.FaceAnnotation.yml | 2 +- .../fixtures/docfx/Vision/V1.ImageContext.yml | 4 +- .../Vision/V1.ImportProductSetsResponse.yml | 4 +- .../Vision/V1.ListProductSetsResponse.yml | 2 +- .../V1.ListProductsInProductSetResponse.yml | 2 +- .../docfx/Vision/V1.ListProductsResponse.yml | 2 +- .../Vision/V1.ListReferenceImagesResponse.yml | 2 +- dev/tests/fixtures/docfx/Vision/V1.Page.yml | 2 +- .../fixtures/docfx/Vision/V1.Paragraph.yml | 2 +- .../fixtures/docfx/Vision/V1.Product.yml | 2 +- .../docfx/Vision/V1.ProductSearchParams.yml | 4 +- .../V1.ProductSearchResults.GroupedResult.yml | 4 +- .../docfx/Vision/V1.ProductSearchResults.yml | 4 +- .../docfx/Vision/V1.ReferenceImage.yml | 2 +- .../docfx/Vision/V1.SafeSearchAnnotation.yml | 222 ------------------ .../Vision/V1.TextAnnotation.TextProperty.yml | 2 +- .../docfx/Vision/V1.TextAnnotation.yml | 2 +- .../docfx/Vision/V1.TextDetectionParams.yml | 4 +- .../docfx/Vision/V1.WebDetection.WebPage.yml | 4 +- .../fixtures/docfx/Vision/V1.WebDetection.yml | 12 +- dev/tests/fixtures/docfx/Vision/V1.Word.yml | 2 +- dev/tests/fixtures/docfx/Vision/toc.yml | 54 ++--- 43 files changed, 116 insertions(+), 328 deletions(-) diff --git a/dev/tests/Unit/Command/DocFxCommandTest.php b/dev/tests/Unit/Command/DocFxCommandTest.php index 3388abc58907..61b9b805ebd4 100644 --- a/dev/tests/Unit/Command/DocFxCommandTest.php +++ b/dev/tests/Unit/Command/DocFxCommandTest.php @@ -41,7 +41,7 @@ public function testGenerateVisionStructureXml() $componentDir = __DIR__ . '/../../../../Vision'; $process = DocFxCommand::getPhpDocCommand($componentDir, self::$tmpDir); $process->mustRun(); - $left = self::$fixturesDir . '/phpdoc/structure.xml'; + $left = self::$fixturesDir . '/phpdoc/vision.xml'; $right = self::$tmpDir . '/structure.xml'; $this->assertFileEqualsWithDiff($left, $right, '1' === getenv('UPDATE_FIXTURES')); @@ -138,7 +138,7 @@ public function provideDocFxFiles() { $output = self::getCommandTester()->execute([ '--component' => 'Vision', - '--xml' => self::$fixturesDir . '/phpdoc/structure.xml', + '--xml' => self::$fixturesDir . '/phpdoc/vision.xml', '--out' => self::$tmpDir = sys_get_temp_dir() . '/' . rand(), '--metadata-version' => '1.0.0', '--path' => self::$fixturesDir . '/component/Vision', diff --git a/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileRequest.yml index c983323f02ec..0f2aa7d9fe02 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileRequest.yml @@ -56,7 +56,7 @@ items: description: 'Additional context that may accompany the image(s) in the file.' - id: '↳ pages' - var_type: array + var_type: 'int[]' description: 'Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file.' - uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::getInputConfig()' @@ -117,7 +117,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Feature>' - uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::setFeatures()' name: setFeatures @@ -206,7 +206,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<int>' - uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::setPages()' name: setPages diff --git a/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.yml index 46592d1cc11b..15d0a8876015 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.yml @@ -120,7 +120,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<AnnotateImageResponse>' - uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::setResponses()' name: setResponses diff --git a/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageRequest.yml index 4820df7b9c4e..84c26350184a 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageRequest.yml @@ -112,7 +112,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Feature>' - uid: '\Google\Cloud\Vision\V1\AnnotateImageRequest::setFeatures()' name: setFeatures diff --git a/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageResponse.yml index dc77b3515cc8..194a287fb07d 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageResponse.yml @@ -142,7 +142,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<FaceAnnotation>' - uid: '\Google\Cloud\Vision\V1\AnnotateImageResponse::setFaceAnnotations()' name: setFaceAnnotations @@ -173,7 +173,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<EntityAnnotation>' - uid: '\Google\Cloud\Vision\V1\AnnotateImageResponse::setLandmarkAnnotations()' name: setLandmarkAnnotations @@ -204,7 +204,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<EntityAnnotation>' - uid: '\Google\Cloud\Vision\V1\AnnotateImageResponse::setLogoAnnotations()' name: setLogoAnnotations @@ -235,7 +235,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<EntityAnnotation>' - uid: '\Google\Cloud\Vision\V1\AnnotateImageResponse::setLabelAnnotations()' name: setLabelAnnotations @@ -269,7 +269,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<LocalizedObjectAnnotation>' - uid: '\Google\Cloud\Vision\V1\AnnotateImageResponse::setLocalizedObjectAnnotations()' name: setLocalizedObjectAnnotations @@ -303,7 +303,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<EntityAnnotation>' - uid: '\Google\Cloud\Vision\V1\AnnotateImageResponse::setTextAnnotations()' name: setTextAnnotations diff --git a/dev/tests/fixtures/docfx/Vision/V1.AsyncAnnotateFileRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.AsyncAnnotateFileRequest.yml index 3a919f111913..0728bb616ddf 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AsyncAnnotateFileRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AsyncAnnotateFileRequest.yml @@ -119,7 +119,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Feature>' - uid: '\Google\Cloud\Vision\V1\AsyncAnnotateFileRequest::setFeatures()' name: setFeatures diff --git a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesRequest.yml index 146e0f5c0855..01ba4c6e259b 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesRequest.yml @@ -62,7 +62,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<AsyncAnnotateFileRequest>' - uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesRequest::setRequests()' name: setRequests diff --git a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesResponse.yml index cc5afba58411..f56994c0b349 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesResponse.yml @@ -50,7 +50,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<AsyncAnnotateFileResponse>' - uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse::setResponses()' name: setResponses diff --git a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml index 645cea2d581c..7254419ef300 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml @@ -69,7 +69,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<AnnotateImageRequest>' - uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setRequests()' name: setRequests diff --git a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesRequest.yml index e0655ae338b3..fae2bb899b89 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesRequest.yml @@ -63,7 +63,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<AnnotateFileRequest>' - uid: '\Google\Cloud\Vision\V1\BatchAnnotateFilesRequest::setRequests()' name: setRequests diff --git a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesResponse.yml index 381781fac910..46fc7888e546 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesResponse.yml @@ -50,7 +50,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<AnnotateFileResponse>' - uid: '\Google\Cloud\Vision\V1\BatchAnnotateFilesResponse::setResponses()' name: setResponses diff --git a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesRequest.yml b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesRequest.yml index 87608dc6c080..6e05b8e6b0f8 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesRequest.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesRequest.yml @@ -61,7 +61,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<AnnotateImageRequest>' - uid: '\Google\Cloud\Vision\V1\BatchAnnotateImagesRequest::setRequests()' name: setRequests diff --git a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesResponse.yml index 9a49de829233..5887557699a7 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesResponse.yml @@ -48,7 +48,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<AnnotateImageResponse>' - uid: '\Google\Cloud\Vision\V1\BatchAnnotateImagesResponse::setResponses()' name: setResponses diff --git a/dev/tests/fixtures/docfx/Vision/V1.Block.yml b/dev/tests/fixtures/docfx/Vision/V1.Block.yml index e02bdbd3e181..1c77332b5c24 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Block.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Block.yml @@ -202,7 +202,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Paragraph>' - uid: '\Google\Cloud\Vision\V1\Block::setParagraphs()' name: setParagraphs diff --git a/dev/tests/fixtures/docfx/Vision/V1.BoundingPoly.yml b/dev/tests/fixtures/docfx/Vision/V1.BoundingPoly.yml index 49582340bedb..f0839075d4dc 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.BoundingPoly.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.BoundingPoly.yml @@ -54,7 +54,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Vertex>' - uid: '\Google\Cloud\Vision\V1\BoundingPoly::setVertices()' name: setVertices @@ -85,7 +85,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<NormalizedVertex>' - uid: '\Google\Cloud\Vision\V1\BoundingPoly::setNormalizedVertices()' name: setNormalizedVertices diff --git a/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml b/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml index 31a92299d86d..71b574133e1f 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml @@ -48,7 +48,7 @@ items: parameters: - id: options - var_type: array + var_type: 'array|Google\ApiCore\Options\ClientOptions' description: 'Optional. Options for configuring the service API wrapper.' - id: '↳ apiEndpoint' @@ -56,8 +56,8 @@ items: description: 'The address of the API remote host. May optionally include the port, formatted as ":". Default ''vision.googleapis.com:443''.' - id: '↳ credentials' - var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper - description: '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.' + var_type: FetchAuthTokenInterface|CredentialsWrapper + description: 'This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important**: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly ``` use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Vision\V1\ImageAnnotatorClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new ImageAnnotatorClient([''credentials'' => $creds]); ``` https://cloud.google.com/docs/authentication/external/externally-sourced-credentials' - id: '↳ credentialsConfig' var_type: array @@ -82,6 +82,14 @@ items: id: '↳ clientCertSource' var_type: callable description: '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.' + - + id: '↳ logger' + var_type: false|LoggerInterface + description: "A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag" + - + id: '↳ universeDomain' + var_type: string + description: "The service domain for the client. Defaults to 'googleapis.com'." - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateFiles()' name: asyncBatchAnnotateFiles @@ -162,7 +170,7 @@ items: description: '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: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse<Google\Cloud\Vision\V1\AsyncBatchAnnotateFilesResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImages()' name: asyncBatchAnnotateImages @@ -247,7 +255,7 @@ items: description: '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: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse<Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFiles()' name: batchAnnotateFiles @@ -475,7 +483,7 @@ items: syntax: returns: - - var_type: 'Google\ApiCore\LongRunning\OperationsClient' + var_type: 'Google\LongRunning\Client\OperationsClient' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::resumeOperation()' name: resumeOperation @@ -559,7 +567,7 @@ items: description: 'The formatted name string' - id: template - var_type: string + var_type: '?string' description: 'Optional name of template to match' returns: - diff --git a/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml b/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml index 22b7d8373be9..2e6808dbb8ff 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml @@ -94,7 +94,7 @@ items: parameters: - id: options - var_type: array + var_type: 'array|Google\ApiCore\Options\ClientOptions' description: 'Optional. Options for configuring the service API wrapper.' - id: '↳ apiEndpoint' @@ -102,8 +102,8 @@ items: description: 'The address of the API remote host. May optionally include the port, formatted as ":". Default ''vision.googleapis.com:443''.' - id: '↳ credentials' - var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper - description: '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.' + var_type: FetchAuthTokenInterface|CredentialsWrapper + description: 'This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important**: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly ``` use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Vision\V1\ProductSearchClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new ProductSearchClient([''credentials'' => $creds]); ``` https://cloud.google.com/docs/authentication/external/externally-sourced-credentials' - id: '↳ credentialsConfig' var_type: array @@ -128,6 +128,14 @@ items: id: '↳ clientCertSource' var_type: callable description: '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.' + - + id: '↳ logger' + var_type: false|LoggerInterface + description: "A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag" + - + id: '↳ universeDomain' + var_type: string + description: "The service domain for the client. Defaults to 'googleapis.com'." - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::addProductToProductSet()' name: addProductToProductSet @@ -1037,7 +1045,7 @@ items: description: '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: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse<Google\Cloud\Vision\V1\ImportProductSetsResponse>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSets()' name: listProductSets @@ -1479,7 +1487,7 @@ items: description: '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: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse<null>' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSet()' name: removeProductFromProductSet @@ -2114,7 +2122,7 @@ items: syntax: returns: - - var_type: 'Google\ApiCore\LongRunning\OperationsClient' + var_type: 'Google\LongRunning\Client\OperationsClient' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::resumeOperation()' name: resumeOperation @@ -2288,7 +2296,7 @@ items: description: 'The formatted name string' - id: template - var_type: string + var_type: '?string' description: 'Optional name of template to match' returns: - diff --git a/dev/tests/fixtures/docfx/Vision/V1.CropHintsAnnotation.yml b/dev/tests/fixtures/docfx/Vision/V1.CropHintsAnnotation.yml index 2183556da150..744576c7ca7b 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.CropHintsAnnotation.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.CropHintsAnnotation.yml @@ -48,7 +48,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<CropHint>' - uid: '\Google\Cloud\Vision\V1\CropHintsAnnotation::setCropHints()' name: setCropHints diff --git a/dev/tests/fixtures/docfx/Vision/V1.CropHintsParams.yml b/dev/tests/fixtures/docfx/Vision/V1.CropHintsParams.yml index afe8648ef9bf..b0d0504c68f6 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.CropHintsParams.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.CropHintsParams.yml @@ -34,7 +34,7 @@ items: description: 'Optional. Data for populating the Message object.' - id: '↳ aspect_ratios' - var_type: array + var_type: 'float[]' description: 'Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.' - uid: '\Google\Cloud\Vision\V1\CropHintsParams::getAspectRatios()' @@ -54,7 +54,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<float>' - uid: '\Google\Cloud\Vision\V1\CropHintsParams::setAspectRatios()' name: setAspectRatios diff --git a/dev/tests/fixtures/docfx/Vision/V1.DominantColorsAnnotation.yml b/dev/tests/fixtures/docfx/Vision/V1.DominantColorsAnnotation.yml index 0360a848f647..cd42c9fa4b45 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.DominantColorsAnnotation.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.DominantColorsAnnotation.yml @@ -48,7 +48,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<ColorInfo>' - uid: '\Google\Cloud\Vision\V1\DominantColorsAnnotation::setColors()' name: setColors diff --git a/dev/tests/fixtures/docfx/Vision/V1.EntityAnnotation.yml b/dev/tests/fixtures/docfx/Vision/V1.EntityAnnotation.yml index 8f8625d8e928..28036b698bf0 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.EntityAnnotation.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.EntityAnnotation.yml @@ -373,7 +373,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<LocationInfo>' - uid: '\Google\Cloud\Vision\V1\EntityAnnotation::setLocations()' name: setLocations @@ -412,7 +412,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Property>' - uid: '\Google\Cloud\Vision\V1\EntityAnnotation::setProperties()' name: setProperties diff --git a/dev/tests/fixtures/docfx/Vision/V1.FaceAnnotation.yml b/dev/tests/fixtures/docfx/Vision/V1.FaceAnnotation.yml index a20a9af9013b..95c2e87722a6 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.FaceAnnotation.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.FaceAnnotation.yml @@ -258,7 +258,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<FaceAnnotation\Landmark>' - uid: '\Google\Cloud\Vision\V1\FaceAnnotation::setLandmarks()' name: setLandmarks diff --git a/dev/tests/fixtures/docfx/Vision/V1.ImageContext.yml b/dev/tests/fixtures/docfx/Vision/V1.ImageContext.yml index ad80adb1f319..efaf49c976d3 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ImageContext.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ImageContext.yml @@ -58,7 +58,7 @@ items: description: 'Not used.' - id: '↳ language_hints' - var_type: array + var_type: 'string[]' description: 'List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages).' - id: '↳ crop_hints_params' @@ -143,7 +143,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<string>' - uid: '\Google\Cloud\Vision\V1\ImageContext::setLanguageHints()' name: setLanguageHints diff --git a/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml index 7dcff1027d61..bc8d61ac576d 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml @@ -60,7 +60,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<ReferenceImage>' - uid: '\Google\Cloud\Vision\V1\ImportProductSetsResponse::setReferenceImages()' name: setReferenceImages @@ -97,7 +97,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Google\Rpc\Status>' - uid: '\Google\Cloud\Vision\V1\ImportProductSetsResponse::setStatuses()' name: setStatuses diff --git a/dev/tests/fixtures/docfx/Vision/V1.ListProductSetsResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.ListProductSetsResponse.yml index 2a4f806280d6..bef59c4ed010 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ListProductSetsResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ListProductSetsResponse.yml @@ -54,7 +54,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<ProductSet>' - uid: '\Google\Cloud\Vision\V1\ListProductSetsResponse::setProductSets()' name: setProductSets diff --git a/dev/tests/fixtures/docfx/Vision/V1.ListProductsInProductSetResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.ListProductsInProductSetResponse.yml index 2dfecf4dea33..82ef00d0baa2 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ListProductsInProductSetResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ListProductsInProductSetResponse.yml @@ -54,7 +54,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Product>' - uid: '\Google\Cloud\Vision\V1\ListProductsInProductSetResponse::setProducts()' name: setProducts diff --git a/dev/tests/fixtures/docfx/Vision/V1.ListProductsResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.ListProductsResponse.yml index cc44a73c1a54..f4208efa9062 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ListProductsResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ListProductsResponse.yml @@ -54,7 +54,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Product>' - uid: '\Google\Cloud\Vision\V1\ListProductsResponse::setProducts()' name: setProducts diff --git a/dev/tests/fixtures/docfx/Vision/V1.ListReferenceImagesResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.ListReferenceImagesResponse.yml index 167f78db9ed9..26ebfc869a9e 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ListReferenceImagesResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ListReferenceImagesResponse.yml @@ -60,7 +60,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<ReferenceImage>' - uid: '\Google\Cloud\Vision\V1\ListReferenceImagesResponse::setReferenceImages()' name: setReferenceImages diff --git a/dev/tests/fixtures/docfx/Vision/V1.Page.yml b/dev/tests/fixtures/docfx/Vision/V1.Page.yml index 203f55d13ca4..eb847d1a9f75 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Page.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Page.yml @@ -191,7 +191,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Block>' - uid: '\Google\Cloud\Vision\V1\Page::setBlocks()' name: setBlocks diff --git a/dev/tests/fixtures/docfx/Vision/V1.Paragraph.yml b/dev/tests/fixtures/docfx/Vision/V1.Paragraph.yml index ba6c4c07bd73..675ededa6af9 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Paragraph.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Paragraph.yml @@ -196,7 +196,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Word>' - uid: '\Google\Cloud\Vision\V1\Paragraph::setWords()' name: setWords diff --git a/dev/tests/fixtures/docfx/Vision/V1.Product.yml b/dev/tests/fixtures/docfx/Vision/V1.Product.yml index 0cef894d0a8c..8f6b376c15a9 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Product.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Product.yml @@ -237,7 +237,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Product\KeyValue>' - uid: '\Google\Cloud\Vision\V1\Product::setProductLabels()' name: setProductLabels diff --git a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchParams.yml b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchParams.yml index 89ab48789dde..53a50a6feed8 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchParams.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchParams.yml @@ -50,7 +50,7 @@ items: description: 'The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.' - id: '↳ product_categories' - var_type: array + var_type: 'string[]' description: 'The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well.' - id: '↳ filter' @@ -169,7 +169,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<string>' - uid: '\Google\Cloud\Vision\V1\ProductSearchParams::setProductCategories()' name: setProductCategories diff --git a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchResults.GroupedResult.yml b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchResults.GroupedResult.yml index 50139ded2953..d2b7782dac07 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchResults.GroupedResult.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchResults.GroupedResult.yml @@ -110,7 +110,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Result>' - uid: '\Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::setResults()' name: setResults @@ -141,7 +141,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<ObjectAnnotation>' - uid: '\Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult::setObjectAnnotations()' name: setObjectAnnotations diff --git a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchResults.yml b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchResults.yml index 0950748895cd..9f21a982b82c 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchResults.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchResults.yml @@ -115,7 +115,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<ProductSearchResults\Result>' - uid: '\Google\Cloud\Vision\V1\ProductSearchResults::setResults()' name: setResults @@ -150,7 +150,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<ProductSearchResults\GroupedResult>' - uid: '\Google\Cloud\Vision\V1\ProductSearchResults::setProductGroupedResults()' name: setProductGroupedResults diff --git a/dev/tests/fixtures/docfx/Vision/V1.ReferenceImage.yml b/dev/tests/fixtures/docfx/Vision/V1.ReferenceImage.yml index c851f2be5f18..3035039f908c 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ReferenceImage.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ReferenceImage.yml @@ -147,7 +147,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<BoundingPoly>' - uid: '\Google\Cloud\Vision\V1\ReferenceImage::setBoundingPolys()' name: setBoundingPolys diff --git a/dev/tests/fixtures/docfx/Vision/V1.SafeSearchAnnotation.yml b/dev/tests/fixtures/docfx/Vision/V1.SafeSearchAnnotation.yml index f44878cdaa2a..9e67e9e11930 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.SafeSearchAnnotation.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.SafeSearchAnnotation.yml @@ -27,18 +27,6 @@ items: - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setViolence()' - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getRacy()' - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setRacy()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getAdultConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setAdultConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getSpoofConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setSpoofConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getMedicalConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setMedicalConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getViolenceConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setViolenceConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getRacyConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setRacyConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getNsfwConfidence()' - - '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setNsfwConfidence()' - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::__construct()' name: __construct @@ -260,213 +248,3 @@ items: returns: - var_type: $this - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getAdultConfidence()' - name: getAdultConfidence - id: getAdultConfidence - summary: |- - Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means - very confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - returns: - - - var_type: float - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setAdultConfidence()' - name: setAdultConfidence - id: setAdultConfidence - summary: |- - Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means - very confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - parameters: - - - id: var - var_type: float - description: '' - returns: - - - var_type: $this - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getSpoofConfidence()' - name: getSpoofConfidence - id: getSpoofConfidence - summary: |- - Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means - very confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - returns: - - - var_type: float - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setSpoofConfidence()' - name: setSpoofConfidence - id: setSpoofConfidence - summary: |- - Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means - very confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - parameters: - - - id: var - var_type: float - description: '' - returns: - - - var_type: $this - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getMedicalConfidence()' - name: getMedicalConfidence - id: getMedicalConfidence - summary: |- - Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means - very confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - returns: - - - var_type: float - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setMedicalConfidence()' - name: setMedicalConfidence - id: setMedicalConfidence - summary: |- - Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means - very confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - parameters: - - - id: var - var_type: float - description: '' - returns: - - - var_type: $this - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getViolenceConfidence()' - name: getViolenceConfidence - id: getViolenceConfidence - summary: |- - Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means - very confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - returns: - - - var_type: float - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setViolenceConfidence()' - name: setViolenceConfidence - id: setViolenceConfidence - summary: |- - Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means - very confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - parameters: - - - id: var - var_type: float - description: '' - returns: - - - var_type: $this - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getRacyConfidence()' - name: getRacyConfidence - id: getRacyConfidence - summary: |- - Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very - confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - returns: - - - var_type: float - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setRacyConfidence()' - name: setRacyConfidence - id: setRacyConfidence - summary: |- - Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very - confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - parameters: - - - id: var - var_type: float - description: '' - returns: - - - var_type: $this - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::getNsfwConfidence()' - name: getNsfwConfidence - id: getNsfwConfidence - summary: |- - Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very - confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - returns: - - - var_type: float - - - uid: '\Google\Cloud\Vision\V1\SafeSearchAnnotation::setNsfwConfidence()' - name: setNsfwConfidence - id: setNsfwConfidence - summary: |- - Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very - confident. - parent: \Google\Cloud\Vision\V1\SafeSearchAnnotation - type: method - langs: - - php - syntax: - parameters: - - - id: var - var_type: float - description: '' - returns: - - - var_type: $this diff --git a/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.TextProperty.yml b/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.TextProperty.yml index dc9a3288b6db..2a7f413ea607 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.TextProperty.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.TextProperty.yml @@ -56,7 +56,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<DetectedLanguage>' - uid: '\Google\Cloud\Vision\V1\TextAnnotation\TextProperty::setDetectedLanguages()' name: setDetectedLanguages diff --git a/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.yml b/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.yml index 60981b6329d8..28943773969f 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.TextAnnotation.yml @@ -62,7 +62,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Page>' - uid: '\Google\Cloud\Vision\V1\TextAnnotation::setPages()' name: setPages diff --git a/dev/tests/fixtures/docfx/Vision/V1.TextDetectionParams.yml b/dev/tests/fixtures/docfx/Vision/V1.TextDetectionParams.yml index 3f13483ca537..55ec931ff2b2 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.TextDetectionParams.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.TextDetectionParams.yml @@ -41,7 +41,7 @@ items: description: 'By default, Cloud Vision API only includes confidence score for DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence score for TEXT_DETECTION as well.' - id: '↳ advanced_ocr_options' - var_type: array + var_type: 'string[]' description: 'A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.' - uid: '\Google\Cloud\Vision\V1\TextDetectionParams::getEnableTextDetectionConfidenceScore()' @@ -99,7 +99,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<string>' - uid: '\Google\Cloud\Vision\V1\TextDetectionParams::setAdvancedOcrOptions()' name: setAdvancedOcrOptions diff --git a/dev/tests/fixtures/docfx/Vision/V1.WebDetection.WebPage.yml b/dev/tests/fixtures/docfx/Vision/V1.WebDetection.WebPage.yml index cc556ebf9b4c..9d104d4cc11f 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.WebDetection.WebPage.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.WebDetection.WebPage.yml @@ -168,7 +168,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<WebImage>' - uid: '\Google\Cloud\Vision\V1\WebDetection\WebPage::setFullMatchingImages()' name: setFullMatchingImages @@ -207,7 +207,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<WebImage>' - uid: '\Google\Cloud\Vision\V1\WebDetection\WebPage::setPartialMatchingImages()' name: setPartialMatchingImages diff --git a/dev/tests/fixtures/docfx/Vision/V1.WebDetection.yml b/dev/tests/fixtures/docfx/Vision/V1.WebDetection.yml index 18a3b9de6855..451e7f4f335d 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.WebDetection.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.WebDetection.yml @@ -78,7 +78,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<WebDetection\WebEntity>' - uid: '\Google\Cloud\Vision\V1\WebDetection::setWebEntities()' name: setWebEntities @@ -112,7 +112,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<WebDetection\WebImage>' - uid: '\Google\Cloud\Vision\V1\WebDetection::setFullMatchingImages()' name: setFullMatchingImages @@ -150,7 +150,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<WebDetection\WebImage>' - uid: '\Google\Cloud\Vision\V1\WebDetection::setPartialMatchingImages()' name: setPartialMatchingImages @@ -185,7 +185,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<WebDetection\WebPage>' - uid: '\Google\Cloud\Vision\V1\WebDetection::setPagesWithMatchingImages()' name: setPagesWithMatchingImages @@ -216,7 +216,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<WebDetection\WebImage>' - uid: '\Google\Cloud\Vision\V1\WebDetection::setVisuallySimilarImages()' name: setVisuallySimilarImages @@ -250,7 +250,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<WebDetection\WebLabel>' - uid: '\Google\Cloud\Vision\V1\WebDetection::setBestGuessLabels()' name: setBestGuessLabels diff --git a/dev/tests/fixtures/docfx/Vision/V1.Word.yml b/dev/tests/fixtures/docfx/Vision/V1.Word.yml index d3172e1db7db..4977767fbc32 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Word.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Word.yml @@ -199,7 +199,7 @@ items: syntax: returns: - - var_type: 'Google\Protobuf\Internal\RepeatedField' + var_type: 'Google\Protobuf\RepeatedField<Symbol>' - uid: '\Google\Cloud\Vision\V1\Word::setSymbols()' name: setSymbols diff --git a/dev/tests/fixtures/docfx/Vision/toc.yml b/dev/tests/fixtures/docfx/Vision/toc.yml index 53f5059ad604..dda85ab52f26 100644 --- a/dev/tests/fixtures/docfx/Vision/toc.yml +++ b/dev/tests/fixtures/docfx/Vision/toc.yml @@ -16,18 +16,12 @@ name: Services uid: 'services:Google\Cloud\Vision\V1' items: - - - uid: \Google\Cloud\Vision\V1\ImageAnnotatorClient - name: ImageAnnotatorClient - - - uid: \Google\Cloud\Vision\V1\ProductSearchClient - name: ProductSearchClient - uid: \Google\Cloud\Vision\V1\Client\ImageAnnotatorClient - name: 'ImageAnnotatorClient (beta)' + name: ImageAnnotatorClient - uid: \Google\Cloud\Vision\V1\Client\ProductSearchClient - name: 'ProductSearchClient (beta)' + name: ProductSearchClient - name: Messages uid: 'messages:Google\Cloud\Vision\V1' @@ -122,6 +116,9 @@ - uid: \Google\Cloud\Vision\V1\EntityAnnotation name: EntityAnnotation + - + uid: \Google\Cloud\Vision\V1\FaceAnnotation + name: FaceAnnotation - name: FaceAnnotation uid: 'ns:Google\Cloud\Vision\V1\FaceAnnotation' @@ -129,9 +126,6 @@ - uid: \Google\Cloud\Vision\V1\FaceAnnotation\Landmark name: Landmark - - - uid: \Google\Cloud\Vision\V1\FaceAnnotation - name: FaceAnnotation - uid: \Google\Cloud\Vision\V1\Feature name: Feature @@ -231,19 +225,15 @@ - uid: \Google\Cloud\Vision\V1\Position name: Position - - - name: Product - uid: 'ns:Google\Cloud\Vision\V1\Product' - items: - - - uid: \Google\Cloud\Vision\V1\Product\KeyValue - name: KeyValue - uid: \Google\Cloud\Vision\V1\Product name: Product - uid: \Google\Cloud\Vision\V1\ProductSearchParams name: ProductSearchParams + - + uid: \Google\Cloud\Vision\V1\ProductSearchResults + name: ProductSearchResults - name: ProductSearchResults uid: 'ns:Google\Cloud\Vision\V1\ProductSearchResults' @@ -257,15 +247,19 @@ - uid: \Google\Cloud\Vision\V1\ProductSearchResults\Result name: Result - - - uid: \Google\Cloud\Vision\V1\ProductSearchResults - name: ProductSearchResults - uid: \Google\Cloud\Vision\V1\ProductSet name: ProductSet - uid: \Google\Cloud\Vision\V1\ProductSetPurgeConfig name: ProductSetPurgeConfig + - + name: Product + uid: 'ns:Google\Cloud\Vision\V1\Product' + items: + - + uid: \Google\Cloud\Vision\V1\Product\KeyValue + name: KeyValue - uid: \Google\Cloud\Vision\V1\Property name: Property @@ -284,6 +278,9 @@ - uid: \Google\Cloud\Vision\V1\Symbol name: Symbol + - + uid: \Google\Cloud\Vision\V1\TextAnnotation + name: TextAnnotation - name: TextAnnotation uid: 'ns:Google\Cloud\Vision\V1\TextAnnotation' @@ -297,9 +294,6 @@ - uid: \Google\Cloud\Vision\V1\TextAnnotation\TextProperty name: TextProperty - - - uid: \Google\Cloud\Vision\V1\TextAnnotation - name: TextAnnotation - uid: \Google\Cloud\Vision\V1\TextDetectionParams name: TextDetectionParams @@ -312,6 +306,12 @@ - uid: \Google\Cloud\Vision\V1\Vertex name: Vertex + - + uid: \Google\Cloud\Vision\V1\WebDetection + name: WebDetection + - + uid: \Google\Cloud\Vision\V1\WebDetectionParams + name: WebDetectionParams - name: WebDetection uid: 'ns:Google\Cloud\Vision\V1\WebDetection' @@ -328,12 +328,6 @@ - uid: \Google\Cloud\Vision\V1\WebDetection\WebPage name: WebPage - - - uid: \Google\Cloud\Vision\V1\WebDetection - name: WebDetection - - - uid: \Google\Cloud\Vision\V1\WebDetectionParams - name: WebDetectionParams - uid: \Google\Cloud\Vision\V1\Word name: Word