Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class SearchConfig.
SearchConfig stores different properties that will affect search behaviors and search results.
Generated from protobuf message google.cloud.visionai.v1.SearchConfig
Namespace
Google \ Cloud \ VisionAI \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Resource name of the search configuration. For CustomSearchCriteria, search_config would be the search operator name. For Facets, search_config would be the facet dimension name. Format: |
↳ facet_property |
FacetProperty
Establishes a FacetDimension and associated specifications. |
↳ search_criteria_property |
SearchCriteriaProperty
Creates a mapping between a custom SearchCriteria and one or more UGA keys. |
getName
Resource name of the search configuration.
For CustomSearchCriteria, search_config would be the search
operator name. For Facets, search_config would be the facet
dimension name.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Resource name of the search configuration.
For CustomSearchCriteria, search_config would be the search
operator name. For Facets, search_config would be the facet
dimension name.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFacetProperty
Establishes a FacetDimension and associated specifications.
| Returns | |
|---|---|
| Type | Description |
FacetProperty|null |
|
hasFacetProperty
clearFacetProperty
setFacetProperty
Establishes a FacetDimension and associated specifications.
| Parameter | |
|---|---|
| Name | Description |
var |
FacetProperty
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSearchCriteriaProperty
Creates a mapping between a custom SearchCriteria and one or more UGA keys.
| Returns | |
|---|---|
| Type | Description |
SearchCriteriaProperty|null |
|
hasSearchCriteriaProperty
clearSearchCriteriaProperty
setSearchCriteriaProperty
Creates a mapping between a custom SearchCriteria and one or more UGA keys.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchCriteriaProperty
|
| Returns | |
|---|---|
| Type | Description |
$this |
|