1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DiscoveryEngine
  7. \
  8. GoogleCloudDiscoveryengineV1alphaSearchRequest

GoogleCloudDiscoveryengineV1alphaSearchRequest

class GoogleCloudDiscoveryengineV1alphaSearchRequest extends Collection (View source)

Properties

protected $collection_key
protected $boostSpecType
protected $boostSpecDataType
string $branch
string $canonicalFilter
protected $contentSearchSpecType
protected $contentSearchSpecDataType
protected $customFineTuningSpecType
protected $customFineTuningSpecDataType
protected $dataStoreSpecsType
protected $dataStoreSpecsDataType
protected $embeddingSpecType
protected $embeddingSpecDataType
protected $facetSpecsType
protected $facetSpecsDataType
string $filter
protected $imageQueryType
protected $imageQueryDataType
string $languageCode
protected $naturalLanguageQueryUnderstandingSpecType
protected $naturalLanguageQueryUnderstandingSpecDataType
int $offset
string $orderBy
int $pageSize
string $pageToken
array[] $params
string $query
protected $queryExpansionSpecType
protected $queryExpansionSpecDataType
string $rankingExpression
string $regionCode
string $relevanceThreshold
bool $safeSearch
protected $searchAsYouTypeSpecType
protected $searchAsYouTypeSpecDataType
string $servingConfig
string $session
protected $sessionSpecType
protected $sessionSpecDataType
protected $spellCorrectionSpecType
protected $spellCorrectionSpecDataType
protected $userInfoType
protected $userInfoDataType
string[] $userLabels
string $userPseudoId

Methods

setBoostSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec $boostSpec)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec
getBoostSpec()

No description

setBranch($branch)

No description

string
getBranch()

No description

setCanonicalFilter($canonicalFilter)

No description

string
getCanonicalFilter()

No description

setContentSearchSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec $contentSearchSpec)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec
getContentSearchSpec()

No description

setCustomFineTuningSpec(GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec $customFineTuningSpec)

No description

GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec
getCustomFineTuningSpec()

No description

setDataStoreSpecs($dataStoreSpecs)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]
getDataStoreSpecs()

No description

setEmbeddingSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec $embeddingSpec)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec
getEmbeddingSpec()

No description

setFacetSpecs($facetSpecs)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[]
getFacetSpecs()

No description

setFilter($filter)

No description

string
getFilter()

No description

setImageQuery(GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery $imageQuery)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery
getImageQuery()

No description

setLanguageCode($languageCode)

No description

string
getLanguageCode()

No description

setNaturalLanguageQueryUnderstandingSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec $naturalLanguageQueryUnderstandingSpec)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec
getNaturalLanguageQueryUnderstandingSpec()

No description

setOffset($offset)

No description

int
getOffset()

No description

setOrderBy($orderBy)

No description

string
getOrderBy()

No description

setPageSize($pageSize)

No description

int
getPageSize()

No description

setPageToken($pageToken)

No description

string
getPageToken()

No description

setParams($params)

No description

array[]
getParams()

No description

setQuery($query)

No description

string
getQuery()

No description

setQueryExpansionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec $queryExpansionSpec)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec
getQueryExpansionSpec()

No description

setRankingExpression($rankingExpression)

No description

string
getRankingExpression()

No description

setRegionCode($regionCode)

No description

string
getRegionCode()

No description

setRelevanceThreshold($relevanceThreshold)

No description

string
getRelevanceThreshold()

No description

setSafeSearch($safeSearch)

No description

bool
getSafeSearch()

No description

setSearchAsYouTypeSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec $searchAsYouTypeSpec)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec
getSearchAsYouTypeSpec()

No description

setServingConfig($servingConfig)

No description

string
getServingConfig()

No description

setSession($session)

No description

string
getSession()

No description

setSessionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec $sessionSpec)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec
getSessionSpec()

No description

setSpellCorrectionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec $spellCorrectionSpec)

No description

GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec
getSpellCorrectionSpec()

No description

setUserInfo(GoogleCloudDiscoveryengineV1alphaUserInfo $userInfo)

No description

GoogleCloudDiscoveryengineV1alphaUserInfo
getUserInfo()

No description

setUserLabels($userLabels)

No description

string[]
getUserLabels()

No description

setUserPseudoId($userPseudoId)

No description

string
getUserPseudoId()

No description

Details

at line 125
setBoostSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec $boostSpec)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec $boostSpec

at line 132
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec getBoostSpec()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec

at line 139
setBranch($branch)

No description

Parameters

$branch

at line 146
string getBranch()

No description

Return Value

string

at line 153
setCanonicalFilter($canonicalFilter)

No description

Parameters

$canonicalFilter

at line 160
string getCanonicalFilter()

No description

Return Value

string

at line 167
setContentSearchSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec $contentSearchSpec)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec $contentSearchSpec

at line 174
GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec getContentSearchSpec()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec

at line 181
setCustomFineTuningSpec(GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec $customFineTuningSpec)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec $customFineTuningSpec

at line 188
GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec getCustomFineTuningSpec()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec

at line 195
setDataStoreSpecs($dataStoreSpecs)

No description

Parameters

$dataStoreSpecs

at line 202
GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[] getDataStoreSpecs()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]

at line 209
setEmbeddingSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec $embeddingSpec)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec $embeddingSpec

at line 216
GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec getEmbeddingSpec()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec

at line 223
setFacetSpecs($facetSpecs)

No description

Parameters

$facetSpecs

at line 230
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[] getFacetSpecs()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[]

at line 237
setFilter($filter)

No description

Parameters

$filter

at line 244
string getFilter()

No description

Return Value

string

at line 251
setImageQuery(GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery $imageQuery)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery $imageQuery

at line 258
GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery getImageQuery()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery

at line 265
setLanguageCode($languageCode)

No description

Parameters

$languageCode

at line 272
string getLanguageCode()

No description

Return Value

string

at line 279
setNaturalLanguageQueryUnderstandingSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec $naturalLanguageQueryUnderstandingSpec)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec $naturalLanguageQueryUnderstandingSpec

at line 286
GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec getNaturalLanguageQueryUnderstandingSpec()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec

at line 293
setOffset($offset)

No description

Parameters

$offset

at line 300
int getOffset()

No description

Return Value

int

at line 307
setOrderBy($orderBy)

No description

Parameters

$orderBy

at line 314
string getOrderBy()

No description

Return Value

string

at line 321
setPageSize($pageSize)

No description

Parameters

$pageSize

at line 328
int getPageSize()

No description

Return Value

int

at line 335
setPageToken($pageToken)

No description

Parameters

$pageToken

at line 342
string getPageToken()

No description

Return Value

string

at line 349
setParams($params)

No description

Parameters

$params

at line 356
array[] getParams()

No description

Return Value

array[]

at line 363
setQuery($query)

No description

Parameters

$query

at line 370
string getQuery()

No description

Return Value

string

at line 377
setQueryExpansionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec $queryExpansionSpec)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec $queryExpansionSpec

at line 384
GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec getQueryExpansionSpec()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec

at line 391
setRankingExpression($rankingExpression)

No description

Parameters

$rankingExpression

at line 398
string getRankingExpression()

No description

Return Value

string

at line 405
setRegionCode($regionCode)

No description

Parameters

$regionCode

at line 412
string getRegionCode()

No description

Return Value

string

at line 419
setRelevanceThreshold($relevanceThreshold)

No description

Parameters

$relevanceThreshold

at line 426
string getRelevanceThreshold()

No description

Return Value

string

at line 433
setSafeSearch($safeSearch)

No description

Parameters

$safeSearch

at line 440
bool getSafeSearch()

No description

Return Value

bool

at line 447
setSearchAsYouTypeSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec $searchAsYouTypeSpec)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec $searchAsYouTypeSpec

at line 454
GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec getSearchAsYouTypeSpec()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec

at line 461
setServingConfig($servingConfig)

No description

Parameters

$servingConfig

at line 468
string getServingConfig()

No description

Return Value

string

at line 475
setSession($session)

No description

Parameters

$session

at line 482
string getSession()

No description

Return Value

string

at line 489
setSessionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec $sessionSpec)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec $sessionSpec

at line 496
GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec getSessionSpec()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec

at line 503
setSpellCorrectionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec $spellCorrectionSpec)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec $spellCorrectionSpec

at line 510
GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec getSpellCorrectionSpec()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec

at line 517
setUserInfo(GoogleCloudDiscoveryengineV1alphaUserInfo $userInfo)

No description

Parameters

GoogleCloudDiscoveryengineV1alphaUserInfo $userInfo

at line 524
GoogleCloudDiscoveryengineV1alphaUserInfo getUserInfo()

No description

Return Value

GoogleCloudDiscoveryengineV1alphaUserInfo

at line 531
setUserLabels($userLabels)

No description

Parameters

$userLabels

at line 538
string[] getUserLabels()

No description

Return Value

string[]

at line 545
setUserPseudoId($userPseudoId)

No description

Parameters

$userPseudoId

at line 552
string getUserPseudoId()

No description

Return Value

string