Vision AI v1 API - Class SearchIndexEndpointRequest (1.0.0-beta01) 

public sealed class SearchIndexEndpointRequest : IMessage<SearchIndexEndpointRequest>, IEquatable<SearchIndexEndpointRequest>, IDeepCloneable<SearchIndexEndpointRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Vision AI v1 API class SearchIndexEndpointRequest.

Request message for SearchIndexEndpoint.

Inheritance

object > SearchIndexEndpointRequest

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

SearchIndexEndpointRequest()

public SearchIndexEndpointRequest()

SearchIndexEndpointRequest(SearchIndexEndpointRequest)

public SearchIndexEndpointRequest(SearchIndexEndpointRequest other)
Parameter
Name Description
other SearchIndexEndpointRequest

Properties

Criteria

public RepeatedField<Criteria> Criteria { get; }

Criteria applied to search results.

Property Value
Type Description
RepeatedFieldCriteria

ExclusionCriteria

public RepeatedField<Criteria> ExclusionCriteria { get; }

Criteria to exclude from search results. Note that fetch_matched_annotations will be ignored.

Property Value
Type Description
RepeatedFieldCriteria

HasTextQuery

public bool HasTextQuery { get; }

Gets whether the "text_query" field is set

Property Value
Type Description
bool

ImageQuery

public ImageQuery ImageQuery { get; set; }

An image-only query.

Property Value
Type Description
ImageQuery

IndexEndpoint

public string IndexEndpoint { get; set; }

Required. The index endpoint to search. Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'

Property Value
Type Description
string

IndexEndpointAsIndexEndpointName

public IndexEndpointName IndexEndpointAsIndexEndpointName { get; set; }

IndexEndpointName-typed view over the IndexEndpoint resource name property.

Property Value
Type Description
IndexEndpointName

PageSize

public int PageSize { get; set; }

Requested page size. API may return fewer results than requested. If negative, INVALID_ARGUMENT error will be returned. If unspecified or 0, API will pick a default size, which is 10. If the requested page size is larger than the maximum size, API will pick the maximum size, which is 200.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

The continuation token to fetch the next page. If empty, it means it is fetching the first page.

Property Value
Type Description
string

QueryCase

public SearchIndexEndpointRequest.QueryOneofCase QueryCase { get; }
Property Value
Type Description
SearchIndexEndpointRequestQueryOneofCase

TextQuery

public string TextQuery { get; set; }

A text-only query.

Property Value
Type Description
string