Class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.SearchLiteRequest

Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a FAILED_PRECONDITION error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudDiscoveryengineV1alphaSearchResponse>
DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaSearchResponse>
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.SearchLiteRequest
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.SearchLiteRequest : DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaSearchResponse>, IClientServiceRequest<GoogleCloudDiscoveryengineV1alphaSearchResponse>, IClientServiceRequest

Constructors

SearchLiteRequest(IClientService, GoogleCloudDiscoveryengineV1alphaSearchRequest, string)

Constructs a new SearchLite request.

Declaration
public SearchLiteRequest(IClientService service, GoogleCloudDiscoveryengineV1alphaSearchRequest body, string servingConfig)
Parameters
Type Name Description
IClientService service
GoogleCloudDiscoveryengineV1alphaSearchRequest body
string servingConfig

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

ServingConfig

Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, or projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

Declaration
[RequestParameter("servingConfig", RequestParameterType.Path)]
public virtual string ServingConfig { get; }
Property Value
Type Description
string

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes SearchLite parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements