com.clarifai.grpc.api.ConceptOrBuilder 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 ConceptOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.Concept)
com.google.protobuf.MessageOrBuilder {
/**
*
* The concept's unique id.
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* The concept's unique id.
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* The name of the concept in the given language.
*
*
* string name = 2;
* @return The name.
*/
java.lang.String getName();
/**
*
* The name of the concept in the given language.
*
*
* string name = 2;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* Used to indicate presence (1.0) or not (0.0) of this concept when making a request.
* This is also the prediction probability when returning predictions from our API.
* For convenience we use the default of 1.0 when making requests so the concept you provide is
* is treated as a positive (1.0) and not a negative (which would be value == 0.0).
*
*
* float value = 3 [(.clarifai.api.utils.cl_show_if_empty) = true, (.clarifai.api.utils.cl_default_float) = 1];
* @return The value.
*/
float getValue();
/**
*
* When the concept was created. The format is https://www.ietf.org/rfc/rfc3339.txt .
* Example: "2006-01-02T15:04:05.999999Z". This field is used only in a response.
*
*
* .google.protobuf.Timestamp created_at = 4;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the concept was created. The format is https://www.ietf.org/rfc/rfc3339.txt .
* Example: "2006-01-02T15:04:05.999999Z". This field is used only in a response.
*
*
* .google.protobuf.Timestamp created_at = 4;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the concept was created. The format is https://www.ietf.org/rfc/rfc3339.txt .
* Example: "2006-01-02T15:04:05.999999Z". This field is used only in a response.
*
*
* .google.protobuf.Timestamp created_at = 4;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* The language in which the concept name is in. This is *ONLY* used in the response and setting
* it in a request is ignored since the default language of your app is used when creating
* or patching a Concept. To set other languages for your concept use the ConceptLanguage object
* and its corresponding endpoints.
*
*
* string language = 5;
* @return The language.
*/
java.lang.String getLanguage();
/**
*
* The language in which the concept name is in. This is *ONLY* used in the response and setting
* it in a request is ignored since the default language of your app is used when creating
* or patching a Concept. To set other languages for your concept use the ConceptLanguage object
* and its corresponding endpoints.
*
*
* string language = 5;
* @return The bytes for language.
*/
com.google.protobuf.ByteString
getLanguageBytes();
/**
*
* The application id that this concept is within. This can be ignored by most users.
*
*
* string app_id = 6;
* @return The appId.
*/
java.lang.String getAppId();
/**
*
* The application id that this concept is within. This can be ignored by most users.
*
*
* string app_id = 6;
* @return The bytes for appId.
*/
com.google.protobuf.ByteString
getAppIdBytes();
/**
*
* The definition for the concept. Similar to name. This can be ignored by most users.
*
*
* string definition = 7;
* @return The definition.
*/
java.lang.String getDefinition();
/**
*
* The definition for the concept. Similar to name. This can be ignored by most users.
*
*
* string definition = 7;
* @return The bytes for definition.
*/
com.google.protobuf.ByteString
getDefinitionBytes();
/**
*
* The vocabulary that this concept belongs to. This is useful if you have different unique sets
* of concepts that you can separate out based on this field. For example "age_appearance" vs
* "gender_appearance" in a list of concept returned from the demographics model.
*
*
* string vocab_id = 8;
* @return The vocabId.
*/
java.lang.String getVocabId();
/**
*
* The vocabulary that this concept belongs to. This is useful if you have different unique sets
* of concepts that you can separate out based on this field. For example "age_appearance" vs
* "gender_appearance" in a list of concept returned from the demographics model.
*
*
* string vocab_id = 8;
* @return The bytes for vocabId.
*/
com.google.protobuf.ByteString
getVocabIdBytes();
/**
*
* 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 = 9;
* @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 = 9;
* @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 = 9;
*/
com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();
/**
*
* The user the concept belongs to.
*
*
* string user_id = 10;
* @return The userId.
*/
java.lang.String getUserId();
/**
*
* The user the concept belongs to.
*
*
* string user_id = 10;
* @return The bytes for userId.
*/
com.google.protobuf.ByteString
getUserIdBytes();
/**
*
* Information about keypoints for this concept
*
*
* .clarifai.api.KeypointInfo keypoint_info = 11;
* @return Whether the keypointInfo field is set.
*/
boolean hasKeypointInfo();
/**
*
* Information about keypoints for this concept
*
*
* .clarifai.api.KeypointInfo keypoint_info = 11;
* @return The keypointInfo.
*/
com.clarifai.grpc.api.KeypointInfo getKeypointInfo();
/**
*
* Information about keypoints for this concept
*
*
* .clarifai.api.KeypointInfo keypoint_info = 11;
*/
com.clarifai.grpc.api.KeypointInfoOrBuilder getKeypointInfoOrBuilder();
/**
*
* Optional extra info.
*
*
* .clarifai.api.ConceptExtraInfo extra_info = 12;
* @return Whether the extraInfo field is set.
*/
boolean hasExtraInfo();
/**
*
* Optional extra info.
*
*
* .clarifai.api.ConceptExtraInfo extra_info = 12;
* @return The extraInfo.
*/
com.clarifai.grpc.api.ConceptExtraInfo getExtraInfo();
/**
*
* Optional extra info.
*
*
* .clarifai.api.ConceptExtraInfo extra_info = 12;
*/
com.clarifai.grpc.api.ConceptExtraInfoOrBuilder getExtraInfoOrBuilder();
}