com.clarifai.grpc.api.OutputConfigOrBuilder 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 OutputConfigOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.OutputConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
* For custom concept model training: whether the concept predictions must sum to 1.
*
*
* bool concepts_mutually_exclusive = 1 [deprecated = true];
* @deprecated clarifai.api.OutputConfig.concepts_mutually_exclusive is deprecated.
* See proto/clarifai/api/resources.proto;l=1509
* @return The conceptsMutuallyExclusive.
*/
@java.lang.Deprecated boolean getConceptsMutuallyExclusive();
/**
*
* DEPRECATED: For custom models, this is the base model to use for image embeddings.
* Default is general model.
*
*
* string existing_model_id = 3 [deprecated = true];
* @deprecated clarifai.api.OutputConfig.existing_model_id is deprecated.
* See proto/clarifai/api/resources.proto;l=1512
* @return The existingModelId.
*/
@java.lang.Deprecated java.lang.String getExistingModelId();
/**
*
* DEPRECATED: For custom models, this is the base model to use for image embeddings.
* Default is general model.
*
*
* string existing_model_id = 3 [deprecated = true];
* @deprecated clarifai.api.OutputConfig.existing_model_id is deprecated.
* See proto/clarifai/api/resources.proto;l=1512
* @return The bytes for existingModelId.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getExistingModelIdBytes();
/**
*
* For concept model predictions: Overrides the default_language for the app in a predict call.
*
*
* string language = 4;
* @return The language.
*/
java.lang.String getLanguage();
/**
*
* For concept model predictions: Overrides the default_language for the app in a predict call.
*
*
* string language = 4;
* @return The bytes for language.
*/
com.google.protobuf.ByteString
getLanguageBytes();
/**
*
* DEPRECATED: Hyper-parameters for custom training.
* Use new hyper_params field instead.
*
*
* string hyper_parameters = 5 [deprecated = true];
* @deprecated clarifai.api.OutputConfig.hyper_parameters is deprecated.
* See proto/clarifai/api/resources.proto;l=1517
* @return The hyperParameters.
*/
@java.lang.Deprecated java.lang.String getHyperParameters();
/**
*
* DEPRECATED: Hyper-parameters for custom training.
* Use new hyper_params field instead.
*
*
* string hyper_parameters = 5 [deprecated = true];
* @deprecated clarifai.api.OutputConfig.hyper_parameters is deprecated.
* See proto/clarifai/api/resources.proto;l=1517
* @return The bytes for hyperParameters.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getHyperParametersBytes();
/**
*
* For concept model predictions: Maximum number of concepts in result. Defaults to 0 which under
* the hood will return default of 20. We do a server side default in order to control this
* feature in the future.
*
*
* uint32 max_concepts = 6 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The maxConcepts.
*/
int getMaxConcepts();
/**
*
* For concept model predictions: Minimum value of concept's probability 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 = 7 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The minValue.
*/
float getMinValue();
/**
*
* For concept model predictions: Select concepts in result by name or by id
*
*
* repeated .clarifai.api.Concept select_concepts = 8;
*/
java.util.List
getSelectConceptsList();
/**
*
* For concept model predictions: Select concepts in result by name or by id
*
*
* repeated .clarifai.api.Concept select_concepts = 8;
*/
com.clarifai.grpc.api.Concept getSelectConcepts(int index);
/**
*
* For concept model predictions: Select concepts in result by name or by id
*
*
* repeated .clarifai.api.Concept select_concepts = 8;
*/
int getSelectConceptsCount();
/**
*
* For concept model predictions: Select concepts in result by name or by id
*
*
* repeated .clarifai.api.Concept select_concepts = 8;
*/
java.util.List
getSelectConceptsOrBuilderList();
/**
*
* For concept model predictions: Select concepts in result by name or by id
*
*
* repeated .clarifai.api.Concept select_concepts = 8;
*/
com.clarifai.grpc.api.ConceptOrBuilder getSelectConceptsOrBuilder(
int index);
/**
*
* For custom concept model training: Training timeout of the model (in seconds)
*
*
* uint32 training_timeout = 9;
* @return The trainingTimeout.
*/
int getTrainingTimeout();
/**
*
* For model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)
*
*
* uint32 sample_ms = 10;
* @return The sampleMs.
*/
int getSampleMs();
/**
*
* For custom model training: Hyperparameters for custom training
*
*
* .google.protobuf.Struct hyper_params = 13;
* @return Whether the hyperParams field is set.
*/
boolean hasHyperParams();
/**
*
* For custom model training: Hyperparameters for custom training
*
*
* .google.protobuf.Struct hyper_params = 13;
* @return The hyperParams.
*/
com.google.protobuf.Struct getHyperParams();
/**
*
* For custom model training: Hyperparameters for custom training
*
*
* .google.protobuf.Struct hyper_params = 13;
*/
com.google.protobuf.StructOrBuilder getHyperParamsOrBuilder();
/**
*
* For custom model training: this is the base model version to use for image embeddings.
* This has to be one of the embed models in the app workflow.
*
*
* string embed_model_version_id = 14 [deprecated = true];
* @deprecated clarifai.api.OutputConfig.embed_model_version_id is deprecated.
* See proto/clarifai/api/resources.proto;l=1536
* @return The embedModelVersionId.
*/
@java.lang.Deprecated java.lang.String getEmbedModelVersionId();
/**
*
* For custom model training: this is the base model version to use for image embeddings.
* This has to be one of the embed models in the app workflow.
*
*
* string embed_model_version_id = 14 [deprecated = true];
* @deprecated clarifai.api.OutputConfig.embed_model_version_id is deprecated.
* See proto/clarifai/api/resources.proto;l=1536
* @return The bytes for embedModelVersionId.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getEmbedModelVersionIdBytes();
/**
*
* For custom model training: Use this flag to fail on missing positive examples
* By default we fill in the missing with random examples
*
*
* bool fail_on_missing_positive_examples = 15;
* @return The failOnMissingPositiveExamples.
*/
boolean getFailOnMissingPositiveExamples();
/**
*
* For custom model training: This is any additional metadata as a JSON object that we want
* want to persist in the model's output config. This is a useful quick way to set fields for
* introducing fields for new model types so we don't have to add a new proto field and DB field
* each time. Please refer to the documentation or model implementation internally for more
* details on what fields are supported for which models.
* TODO(zeiler): remove this field after Portal is updated.
*
*
* .google.protobuf.Struct model_metadata = 17 [deprecated = true];
* @deprecated clarifai.api.OutputConfig.model_metadata is deprecated.
* See proto/clarifai/api/resources.proto;l=1546
* @return Whether the modelMetadata field is set.
*/
@java.lang.Deprecated boolean hasModelMetadata();
/**
*
* For custom model training: This is any additional metadata as a JSON object that we want
* want to persist in the model's output config. This is a useful quick way to set fields for
* introducing fields for new model types so we don't have to add a new proto field and DB field
* each time. Please refer to the documentation or model implementation internally for more
* details on what fields are supported for which models.
* TODO(zeiler): remove this field after Portal is updated.
*
*
* .google.protobuf.Struct model_metadata = 17 [deprecated = true];
* @deprecated clarifai.api.OutputConfig.model_metadata is deprecated.
* See proto/clarifai/api/resources.proto;l=1546
* @return The modelMetadata.
*/
@java.lang.Deprecated com.google.protobuf.Struct getModelMetadata();
/**
*
* For custom model training: This is any additional metadata as a JSON object that we want
* want to persist in the model's output config. This is a useful quick way to set fields for
* introducing fields for new model types so we don't have to add a new proto field and DB field
* each time. Please refer to the documentation or model implementation internally for more
* details on what fields are supported for which models.
* TODO(zeiler): remove this field after Portal is updated.
*
*
* .google.protobuf.Struct model_metadata = 17 [deprecated = true];
*/
@java.lang.Deprecated com.google.protobuf.StructOrBuilder getModelMetadataOrBuilder();
}