Vertex AI v1beta1 API - Class SearchExamplesRequest (1.0.0-beta24) 

public sealed class SearchExamplesRequest : IMessage<SearchExamplesRequest>, IEquatable<SearchExamplesRequest>, IDeepCloneable<SearchExamplesRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1beta1 API class SearchExamplesRequest.

Request message for [ExampleStoreService.SearchExamples][google.cloud.aiplatform.v1beta1.ExampleStoreService.SearchExamples].

Inheritance

object > SearchExamplesRequest

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

SearchExamplesRequest()

public SearchExamplesRequest()

SearchExamplesRequest(SearchExamplesRequest)

public SearchExamplesRequest(SearchExamplesRequest other)
Parameter
Name Description
other SearchExamplesRequest

Properties

ExampleStore

public string ExampleStore { get; set; }

Required. The name of the ExampleStore resource that examples are retrieved from. Format: projects/{project}/locations/{location}/exampleStores/{example_store}

Property Value
Type Description
string

ExampleStoreAsExampleStoreName

public ExampleStoreName ExampleStoreAsExampleStoreName { get; set; }

ExampleStoreName-typed view over the ExampleStore resource name property.

Property Value
Type Description
ExampleStoreName

ParametersCase

public SearchExamplesRequest.ParametersOneofCase ParametersCase { get; }
Property Value
Type Description
SearchExamplesRequestParametersOneofCase

StoredContentsExampleParameters

public StoredContentsExampleParameters StoredContentsExampleParameters { get; set; }

The parameters of StoredContentsExamples to be searched.

Property Value
Type Description
StoredContentsExampleParameters

TopK

public long TopK { get; set; }

Optional. The number of similar examples to return.

Property Value
Type Description
long