📄 Source: GoogleCloudDiscoveryengineV1CompletionSuggestion.php
<?php
/*
* Copyright 2014 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.
*/
namespace Google\Service\DiscoveryEngine;
class GoogleCloudDiscoveryengineV1CompletionSuggestion extends \Google\Collection
{
protected $collection_key = 'alternativePhrases';
/**
* Alternative matching phrases for this suggestion.
*
* @var string[]
*/
public $alternativePhrases;
/**
* Frequency of this suggestion. Will be used to rank suggestions when score
* is not available.
*
* @var string
*/
public $frequency;
/**
* Global score of this suggestion. Control how this suggestion would be
* scored / ranked.
*
* @var
*/
public $globalScore;
/**
* If two suggestions have the same groupId, they will not be returned
* together. Instead the one ranked higher will be returned. This can be used
* to deduplicate semantically identical suggestions.
*
* @var string
*/
public $groupId;
/**
* The score of this suggestion within its group.
*
* @var
*/
public $groupScore;
/**
* BCP-47 language code of this suggestion.
*
* @var string
*/
public $languageCode;
/**
* Required. The suggestion text.
*
* @var string
*/
public $suggestion;
/**
* Alternative matching phrases for this suggestion.
*
* @param string[] $alternativePhrases
*/
public function setAlternativePhrases($alternativePhrases)
{
$this->alternativePhrases = $alternativePhrases;
}
/**
* @return string[]
*/
public function getAlternativePhrases()
{
return $this->alternativePhrases;
}
/**
* Frequency of this suggestion. Will be used to rank suggestions when score
* is not available.
*
* @param string $frequency
*/
public function setFrequency($frequency)
{
$this->frequency = $frequency;
}
/**
* @return string
*/
public function getFrequency()
{
return $this->frequency;
}
public function setGlobalScore($globalScore)
{
$this->globalScore = $globalScore;
}
public function getGlobalScore()
{
return $this->globalScore;
}
/**
* If two suggestions have the same groupId, they will not be returned
* together. Instead the one ranked higher will be returned. This can be used
* to deduplicate semantically identical suggestions.
*
* @param string $groupId
*/
public function setGroupId($groupId)
{
$this->groupId = $groupId;
}
/**
* @return string
*/
public function getGroupId()
{
return $this->groupId;
}
public function setGroupScore($groupScore)
{
$this->groupScore = $groupScore;
}
public function getGroupScore()
{
return $this->groupScore;
}
/**
* BCP-47 language code of this suggestion.
*
* @param string $languageCode
*/
public function setLanguageCode($languageCode)
{
$this->languageCode = $languageCode;
}
/**
* @return string
*/
public function getLanguageCode()
{
return $this->languageCode;
}
/**
* Required. The suggestion text.
*
* @param string $suggestion
*/
public function setSuggestion($suggestion)
{
$this->suggestion = $suggestion;
}
/**
* @return string
*/
public function getSuggestion()
{
return $this->suggestion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudDiscoveryengineV1CompletionSuggestion::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1CompletionSuggestion');
← Back