com.clarifai.grpc.api.SearchOrBuilder Maven / Gradle / Ivy
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: proto/clarifai/api/resources.proto
package com.clarifai.grpc.api;
public interface SearchOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.Search)
com.google.protobuf.MessageOrBuilder {
/**
*
* Search query.
*
*
* .clarifai.api.Query query = 1;
* @return Whether the query field is set.
*/
boolean hasQuery();
/**
*
* Search query.
*
*
* .clarifai.api.Query query = 1;
* @return The query.
*/
com.clarifai.grpc.api.Query getQuery();
/**
*
* Search query.
*
*
* .clarifai.api.Query query = 1;
*/
com.clarifai.grpc.api.QueryOrBuilder getQueryOrBuilder();
/**
*
* Customer facing, external ID for search to be saved. Provided by the user, e.g. "saved-search-1.
* It is unique per application.
*
*
* string id = 2;
* @return The id.
*/
java.lang.String getId();
/**
*
* Customer facing, external ID for search to be saved. Provided by the user, e.g. "saved-search-1.
* It is unique per application.
*
*
* string id = 2;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* Application that owns this saved search.
*
*
* string application_id = 3;
* @return The applicationId.
*/
java.lang.String getApplicationId();
/**
*
* Application that owns this saved search.
*
*
* string application_id = 3;
* @return The bytes for applicationId.
*/
com.google.protobuf.ByteString
getApplicationIdBytes();
/**
*
* Human readable display name of the saved search.
*
*
* string name = 4;
* @return The name.
*/
java.lang.String getName();
/**
*
* Human readable display name of the saved search.
*
*
* string name = 4;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* "As of" timestamp, indicating a time in the past as of which we want to
* retrieve the annotations satisfying the query.
*
*
* .google.protobuf.Timestamp as_of = 5;
* @return Whether the asOf field is set.
*/
boolean hasAsOf();
/**
*
* "As of" timestamp, indicating a time in the past as of which we want to
* retrieve the annotations satisfying the query.
*
*
* .google.protobuf.Timestamp as_of = 5;
* @return The asOf.
*/
com.google.protobuf.Timestamp getAsOf();
/**
*
* "As of" timestamp, indicating a time in the past as of which we want to
* retrieve the annotations satisfying the query.
*
*
* .google.protobuf.Timestamp as_of = 5;
*/
com.google.protobuf.TimestampOrBuilder getAsOfOrBuilder();
/**
*
* Git hash of the code that ran the filter.
*
*
* string git_hash = 6;
* @return The gitHash.
*/
java.lang.String getGitHash();
/**
*
* Git hash of the code that ran the filter.
*
*
* string git_hash = 6;
* @return The bytes for gitHash.
*/
com.google.protobuf.ByteString
getGitHashBytes();
/**
*
* When the saved search was created.
*
*
* .google.protobuf.Timestamp created_at = 7;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the saved search was created.
*
*
* .google.protobuf.Timestamp created_at = 7;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the saved search was created.
*
*
* .google.protobuf.Timestamp created_at = 7;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When the saved search was updated.
*
*
* .google.protobuf.Timestamp modified_at = 8;
* @return Whether the modifiedAt field is set.
*/
boolean hasModifiedAt();
/**
*
* When the saved search was updated.
*
*
* .google.protobuf.Timestamp modified_at = 8;
* @return The modifiedAt.
*/
com.google.protobuf.Timestamp getModifiedAt();
/**
*
* When the saved search was updated.
*
*
* .google.protobuf.Timestamp modified_at = 8;
*/
com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();
/**
*
* The search algorithm to be used.
* Options are are 'nearest_neighbor', 'brute_force', and 'avg_concept_brute_force'
* The last two perform a brute force search visual search instead of a more scalable distributed
* nearest neighbor search and should be used by advanced users only.
* If not specified we default to nearest neighbor
*
*
* string algorithm = 9;
* @return The algorithm.
*/
java.lang.String getAlgorithm();
/**
*
* The search algorithm to be used.
* Options are are 'nearest_neighbor', 'brute_force', and 'avg_concept_brute_force'
* The last two perform a brute force search visual search instead of a more scalable distributed
* nearest neighbor search and should be used by advanced users only.
* If not specified we default to nearest neighbor
*
*
* string algorithm = 9;
* @return The bytes for algorithm.
*/
com.google.protobuf.ByteString
getAlgorithmBytes();
/**
*
* If true, save this search, and exit without executing the search.
* If false execute the query
*
*
* bool save = 10;
* @return The save.
*/
boolean getSave();
/**
*
* Minimum value of confidence threshold score in result.
* Defaults to 0.0 which means we won't do any thresholding as all probabilities will
* likely be > 0.0.
*
*
* float min_value = 11;
* @return The minValue.
*/
float getMinValue();
/**
*
* The visibility field represents whether this message is privately/publicly visible.
* To be visible to the public the App that contains it AND the User that contains the App must
* also be publicly visible.
*
*
* .clarifai.api.Visibility visibility = 12;
* @return Whether the visibility field is set.
*/
boolean hasVisibility();
/**
*
* The visibility field represents whether this message is privately/publicly visible.
* To be visible to the public the App that contains it AND the User that contains the App must
* also be publicly visible.
*
*
* .clarifai.api.Visibility visibility = 12;
* @return The visibility.
*/
com.clarifai.grpc.api.Visibility getVisibility();
/**
*
* The visibility field represents whether this message is privately/publicly visible.
* To be visible to the public the App that contains it AND the User that contains the App must
* also be publicly visible.
*
*
* .clarifai.api.Visibility visibility = 12;
*/
com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();
/**
* .clarifai.api.Search.Metric metric = 13;
* @return The enum numeric value on the wire for metric.
*/
int getMetricValue();
/**
* .clarifai.api.Search.Metric metric = 13;
* @return The metric.
*/
com.clarifai.grpc.api.Search.Metric getMetric();
}