com.clarifai.grpc.api.ModelOrBuilder 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 ModelOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.Model)
com.google.protobuf.MessageOrBuilder {
/**
*
* The model's ID. Must be unique within a particular app and URL-friendly.
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* The model's ID. Must be unique within a particular app and URL-friendly.
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* DEPRECATED: Please use the model id to name the model.
*
*
* string name = 2 [deprecated = true];
* @deprecated clarifai.api.Model.name is deprecated.
* See proto/clarifai/api/resources.proto;l=1328
* @return The name.
*/
@java.lang.Deprecated java.lang.String getName();
/**
*
* DEPRECATED: Please use the model id to name the model.
*
*
* string name = 2 [deprecated = true];
* @deprecated clarifai.api.Model.name is deprecated.
* See proto/clarifai/api/resources.proto;l=1328
* @return The bytes for name.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getNameBytes();
/**
*
* When the model was created. We follow the XXXX timestamp
* format. We use https://www.ietf.org/rfc/rfc3339.txt format:
* "2006-01-02T15:04:05.999999Z" so you can expect results like
* the following from the API:
* "2017-04-11T21:50:50.223962Z"
*
*
* .google.protobuf.Timestamp created_at = 3;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the model was created. We follow the XXXX timestamp
* format. We use https://www.ietf.org/rfc/rfc3339.txt format:
* "2006-01-02T15:04:05.999999Z" so you can expect results like
* the following from the API:
* "2017-04-11T21:50:50.223962Z"
*
*
* .google.protobuf.Timestamp created_at = 3;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the model was created. We follow the XXXX timestamp
* format. We use https://www.ietf.org/rfc/rfc3339.txt format:
* "2006-01-02T15:04:05.999999Z" so you can expect results like
* the following from the API:
* "2017-04-11T21:50:50.223962Z"
*
*
* .google.protobuf.Timestamp created_at = 3;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When was the most recent model version created at
*
*
* .google.protobuf.Timestamp modified_at = 19;
* @return Whether the modifiedAt field is set.
*/
boolean hasModifiedAt();
/**
*
* When was the most recent model version created at
*
*
* .google.protobuf.Timestamp modified_at = 19;
* @return The modifiedAt.
*/
com.google.protobuf.Timestamp getModifiedAt();
/**
*
* When was the most recent model version created at
*
*
* .google.protobuf.Timestamp modified_at = 19;
*/
com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();
/**
*
* The app the model belongs to.
*
*
* string app_id = 4 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The appId.
*/
java.lang.String getAppId();
/**
*
* The app the model belongs to.
*
*
* string app_id = 4 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The bytes for appId.
*/
com.google.protobuf.ByteString
getAppIdBytes();
/**
*
* Info about the model's output and configuration.
* DEPRECATED: Will be moved to model version
*
*
* .clarifai.api.OutputInfo output_info = 5 [deprecated = true];
* @deprecated clarifai.api.Model.output_info is deprecated.
* See proto/clarifai/api/resources.proto;l=1341
* @return Whether the outputInfo field is set.
*/
@java.lang.Deprecated boolean hasOutputInfo();
/**
*
* Info about the model's output and configuration.
* DEPRECATED: Will be moved to model version
*
*
* .clarifai.api.OutputInfo output_info = 5 [deprecated = true];
* @deprecated clarifai.api.Model.output_info is deprecated.
* See proto/clarifai/api/resources.proto;l=1341
* @return The outputInfo.
*/
@java.lang.Deprecated com.clarifai.grpc.api.OutputInfo getOutputInfo();
/**
*
* Info about the model's output and configuration.
* DEPRECATED: Will be moved to model version
*
*
* .clarifai.api.OutputInfo output_info = 5 [deprecated = true];
*/
@java.lang.Deprecated com.clarifai.grpc.api.OutputInfoOrBuilder getOutputInfoOrBuilder();
/**
*
* A particular version of the model, e.g., to specify the version when creating a workflow or
* when listing Models to include the latest ModelVersion of the model in the response.
*
*
* .clarifai.api.ModelVersion model_version = 6;
* @return Whether the modelVersion field is set.
*/
boolean hasModelVersion();
/**
*
* A particular version of the model, e.g., to specify the version when creating a workflow or
* when listing Models to include the latest ModelVersion of the model in the response.
*
*
* .clarifai.api.ModelVersion model_version = 6;
* @return The modelVersion.
*/
com.clarifai.grpc.api.ModelVersion getModelVersion();
/**
*
* A particular version of the model, e.g., to specify the version when creating a workflow or
* when listing Models to include the latest ModelVersion of the model in the response.
*
*
* .clarifai.api.ModelVersion model_version = 6;
*/
com.clarifai.grpc.api.ModelVersionOrBuilder getModelVersionOrBuilder();
/**
*
* DEPRECATED: Please use the model id to name the model.
*
*
* string display_name = 7 [deprecated = true];
* @deprecated clarifai.api.Model.display_name is deprecated.
* See proto/clarifai/api/resources.proto;l=1346
* @return The displayName.
*/
@java.lang.Deprecated java.lang.String getDisplayName();
/**
*
* DEPRECATED: Please use the model id to name the model.
*
*
* string display_name = 7 [deprecated = true];
* @deprecated clarifai.api.Model.display_name is deprecated.
* See proto/clarifai/api/resources.proto;l=1346
* @return The bytes for displayName.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getDisplayNameBytes();
/**
*
* The user id that the model belongs to.
*
*
* string user_id = 9;
* @return The userId.
*/
java.lang.String getUserId();
/**
*
* The user id that the model belongs to.
*
*
* string user_id = 9;
* @return The bytes for userId.
*/
com.google.protobuf.ByteString
getUserIdBytes();
/**
*
* The default evaluation info. Can be overwritten by eval request.
*
*
* .clarifai.api.EvalInfo default_eval_info = 30;
* @return Whether the defaultEvalInfo field is set.
*/
boolean hasDefaultEvalInfo();
/**
*
* The default evaluation info. Can be overwritten by eval request.
*
*
* .clarifai.api.EvalInfo default_eval_info = 30;
* @return The defaultEvalInfo.
*/
com.clarifai.grpc.api.EvalInfo getDefaultEvalInfo();
/**
*
* The default evaluation info. Can be overwritten by eval request.
*
*
* .clarifai.api.EvalInfo default_eval_info = 30;
*/
com.clarifai.grpc.api.EvalInfoOrBuilder getDefaultEvalInfoOrBuilder();
/**
*
* The ModelType.Id that is used for this model. This is used for all versions and you cannot
* change model_type_id between versions of the same model.
*
*
* string model_type_id = 14;
* @return The modelTypeId.
*/
java.lang.String getModelTypeId();
/**
*
* The ModelType.Id that is used for this model. This is used for all versions and you cannot
* change model_type_id between versions of the same model.
*
*
* string model_type_id = 14;
* @return The bytes for modelTypeId.
*/
com.google.protobuf.ByteString
getModelTypeIdBytes();
/**
*
* The task the model was trained to do
*
*
* string task = 26;
* @return The task.
*/
java.lang.String getTask();
/**
*
* The task the model was trained to do
*
*
* string task = 26;
* @return The bytes for task.
*/
com.google.protobuf.ByteString
getTaskBytes();
/**
*
* 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 = 15;
* @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 = 15;
* @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 = 15;
*/
com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();
/**
*
* Short description about this model
*
*
* string description = 16;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* Short description about this model
*
*
* string description = 16;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* To handle arbitrary json metadata you can use a struct field:
* https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto
*
*
* .google.protobuf.Struct metadata = 17;
* @return Whether the metadata field is set.
*/
boolean hasMetadata();
/**
*
* To handle arbitrary json metadata you can use a struct field:
* https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto
*
*
* .google.protobuf.Struct metadata = 17;
* @return The metadata.
*/
com.google.protobuf.Struct getMetadata();
/**
*
* To handle arbitrary json metadata you can use a struct field:
* https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto
*
*
* .google.protobuf.Struct metadata = 17;
*/
com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
/**
* .google.protobuf.Struct presets = 27;
* @return Whether the presets field is set.
*/
boolean hasPresets();
/**
* .google.protobuf.Struct presets = 27;
* @return The presets.
*/
com.google.protobuf.Struct getPresets();
/**
* .google.protobuf.Struct presets = 27;
*/
com.google.protobuf.StructOrBuilder getPresetsOrBuilder();
/**
*
* Notes for the model
* This field should be used for in-depth notes and supports up to 64Kbs.
*
*
* string notes = 18;
* @return The notes.
*/
java.lang.String getNotes();
/**
*
* Notes for the model
* This field should be used for in-depth notes and supports up to 64Kbs.
*
*
* string notes = 18;
* @return The bytes for notes.
*/
com.google.protobuf.ByteString
getNotesBytes();
/**
*
* Tags from toolkits category
*
*
* repeated string toolkits = 20 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return A list containing the toolkits.
*/
java.util.List
getToolkitsList();
/**
*
* Tags from toolkits category
*
*
* repeated string toolkits = 20 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The count of toolkits.
*/
int getToolkitsCount();
/**
*
* Tags from toolkits category
*
*
* repeated string toolkits = 20 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the element to return.
* @return The toolkits at the given index.
*/
java.lang.String getToolkits(int index);
/**
*
* Tags from toolkits category
*
*
* repeated string toolkits = 20 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the value to return.
* @return The bytes of the toolkits at the given index.
*/
com.google.protobuf.ByteString
getToolkitsBytes(int index);
/**
*
* Tags from use_cases category
*
*
* repeated string use_cases = 21 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return A list containing the useCases.
*/
java.util.List
getUseCasesList();
/**
*
* Tags from use_cases category
*
*
* repeated string use_cases = 21 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The count of useCases.
*/
int getUseCasesCount();
/**
*
* Tags from use_cases category
*
*
* repeated string use_cases = 21 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the element to return.
* @return The useCases at the given index.
*/
java.lang.String getUseCases(int index);
/**
*
* Tags from use_cases category
*
*
* repeated string use_cases = 21 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the value to return.
* @return The bytes of the useCases at the given index.
*/
com.google.protobuf.ByteString
getUseCasesBytes(int index);
/**
*
* Tags from languages category.
*
*
* repeated string languages = 25 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return A list containing the languages.
*/
java.util.List
getLanguagesList();
/**
*
* Tags from languages category.
*
*
* repeated string languages = 25 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The count of languages.
*/
int getLanguagesCount();
/**
*
* Tags from languages category.
*
*
* repeated string languages = 25 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the element to return.
* @return The languages at the given index.
*/
java.lang.String getLanguages(int index);
/**
*
* Tags from languages category.
*
*
* repeated string languages = 25 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the value to return.
* @return The bytes of the languages at the given index.
*/
com.google.protobuf.ByteString
getLanguagesBytes(int index);
/**
*
* Tags from languages category with names, only used in responses.
*
*
* repeated .clarifai.api.FullTag languages_full = 31 [(.clarifai.api.utils.cl_show_if_empty) = true];
*/
java.util.List
getLanguagesFullList();
/**
*
* Tags from languages category with names, only used in responses.
*
*
* repeated .clarifai.api.FullTag languages_full = 31 [(.clarifai.api.utils.cl_show_if_empty) = true];
*/
com.clarifai.grpc.api.FullTag getLanguagesFull(int index);
/**
*
* Tags from languages category with names, only used in responses.
*
*
* repeated .clarifai.api.FullTag languages_full = 31 [(.clarifai.api.utils.cl_show_if_empty) = true];
*/
int getLanguagesFullCount();
/**
*
* Tags from languages category with names, only used in responses.
*
*
* repeated .clarifai.api.FullTag languages_full = 31 [(.clarifai.api.utils.cl_show_if_empty) = true];
*/
java.util.List
getLanguagesFullOrBuilderList();
/**
*
* Tags from languages category with names, only used in responses.
*
*
* repeated .clarifai.api.FullTag languages_full = 31 [(.clarifai.api.utils.cl_show_if_empty) = true];
*/
com.clarifai.grpc.api.FullTagOrBuilder getLanguagesFullOrBuilder(
int index);
/**
* repeated string check_consents = 32 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return A list containing the checkConsents.
*/
java.util.List
getCheckConsentsList();
/**
* repeated string check_consents = 32 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The count of checkConsents.
*/
int getCheckConsentsCount();
/**
* repeated string check_consents = 32 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the element to return.
* @return The checkConsents at the given index.
*/
java.lang.String getCheckConsents(int index);
/**
* repeated string check_consents = 32 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the value to return.
* @return The bytes of the checkConsents at the given index.
*/
com.google.protobuf.ByteString
getCheckConsentsBytes(int index);
/**
*
* Is starred by the requesting user (only showed on get/list requests)
* Please use PostModelStars/DeleteModelStars endpoints to star/unstar a model
*
*
* bool is_starred = 22;
* @return The isStarred.
*/
boolean getIsStarred();
/**
*
* How many users have starred the model (only showed on get/list requests)
* Computed value, not editable
*
*
* int32 star_count = 23;
* @return The starCount.
*/
int getStarCount();
/**
*
* Whether it's recommended that this model is used within a workflow
*
*
* .google.protobuf.BoolValue workflow_recommended = 29;
* @return Whether the workflowRecommended field is set.
*/
boolean hasWorkflowRecommended();
/**
*
* Whether it's recommended that this model is used within a workflow
*
*
* .google.protobuf.BoolValue workflow_recommended = 29;
* @return The workflowRecommended.
*/
com.google.protobuf.BoolValue getWorkflowRecommended();
/**
*
* Whether it's recommended that this model is used within a workflow
*
*
* .google.protobuf.BoolValue workflow_recommended = 29;
*/
com.google.protobuf.BoolValueOrBuilder getWorkflowRecommendedOrBuilder();
/**
*
* bookmark info. When set, this model is a bookmarked model of this app.
* Info in this field will allow you to find/access original model.
*
*
* .clarifai.api.BookmarkOrigin bookmark_origin = 33;
* @return Whether the bookmarkOrigin field is set.
*/
boolean hasBookmarkOrigin();
/**
*
* bookmark info. When set, this model is a bookmarked model of this app.
* Info in this field will allow you to find/access original model.
*
*
* .clarifai.api.BookmarkOrigin bookmark_origin = 33;
* @return The bookmarkOrigin.
*/
com.clarifai.grpc.api.BookmarkOrigin getBookmarkOrigin();
/**
*
* bookmark info. When set, this model is a bookmarked model of this app.
* Info in this field will allow you to find/access original model.
*
*
* .clarifai.api.BookmarkOrigin bookmark_origin = 33;
*/
com.clarifai.grpc.api.BookmarkOriginOrBuilder getBookmarkOriginOrBuilder();
/**
*
* Representative image for this model
*
*
* .clarifai.api.Image image = 34;
* @return Whether the image field is set.
*/
boolean hasImage();
/**
*
* Representative image for this model
*
*
* .clarifai.api.Image image = 34;
* @return The image.
*/
com.clarifai.grpc.api.Image getImage();
/**
*
* Representative image for this model
*
*
* .clarifai.api.Image image = 34;
*/
com.clarifai.grpc.api.ImageOrBuilder getImageOrBuilder();
}