com.clarifai.grpc.api.ConceptRelationOrBuilder 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 ConceptRelationOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.ConceptRelation)
com.google.protobuf.MessageOrBuilder {
/**
*
* ID of the concept relation
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* ID of the concept relation
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* The subject concept (i.e. source) of the concept relation
*
*
* .clarifai.api.Concept subject_concept = 2;
* @return Whether the subjectConcept field is set.
*/
boolean hasSubjectConcept();
/**
*
* The subject concept (i.e. source) of the concept relation
*
*
* .clarifai.api.Concept subject_concept = 2;
* @return The subjectConcept.
*/
com.clarifai.grpc.api.Concept getSubjectConcept();
/**
*
* The subject concept (i.e. source) of the concept relation
*
*
* .clarifai.api.Concept subject_concept = 2;
*/
com.clarifai.grpc.api.ConceptOrBuilder getSubjectConceptOrBuilder();
/**
*
* The subject concept (i.e. destination) of the concept relation
*
*
* .clarifai.api.Concept object_concept = 3;
* @return Whether the objectConcept field is set.
*/
boolean hasObjectConcept();
/**
*
* The subject concept (i.e. destination) of the concept relation
*
*
* .clarifai.api.Concept object_concept = 3;
* @return The objectConcept.
*/
com.clarifai.grpc.api.Concept getObjectConcept();
/**
*
* The subject concept (i.e. destination) of the concept relation
*
*
* .clarifai.api.Concept object_concept = 3;
*/
com.clarifai.grpc.api.ConceptOrBuilder getObjectConceptOrBuilder();
/**
*
* The predicate (i.e. edge) linking the subject and the object
* Both subject_concept and object_concept are concepts.
* The predicate is the type of relationship.
* That predicate acts on the subject.
* There are three current types of predicates:
* 1) "hyponym"
* 2) "hypernym"
* 3) "synonym"
* 1) For example, 'hyponym' is a type of predicate which represents 'is_a_kind_of' relation so
* the following relationship:
* 'honey' (subject), 'hyponym' (predicate), 'food' (object)
* Can more easily be read as:
* 'honey' 'is a kind of' 'food'
* 2) The 'hypernym' relation is the opposite of 'hyponym' and when you add one of the
* relationships the opposite will automatically appear for you in queries.
* The 'hypernym' can be read as 'is a parent of' so:
* 'food' (subject), 'hypernym' (predicate), 'honey' (object)
* Can more easily be read as:
* 'food' is a parent of 'honey'
* 3) The 'synonym' relation defines two concepts that essential mean the same thing. This
* is more like a "is" relationship. So for example a 'synonym' relationship could be:
* "puppy" is "pup"
* The reverse is also true once the former is added so:
* "pup" is "puppy"
* will appear in queries as well.
*
*
* string predicate = 4;
* @return The predicate.
*/
java.lang.String getPredicate();
/**
*
* The predicate (i.e. edge) linking the subject and the object
* Both subject_concept and object_concept are concepts.
* The predicate is the type of relationship.
* That predicate acts on the subject.
* There are three current types of predicates:
* 1) "hyponym"
* 2) "hypernym"
* 3) "synonym"
* 1) For example, 'hyponym' is a type of predicate which represents 'is_a_kind_of' relation so
* the following relationship:
* 'honey' (subject), 'hyponym' (predicate), 'food' (object)
* Can more easily be read as:
* 'honey' 'is a kind of' 'food'
* 2) The 'hypernym' relation is the opposite of 'hyponym' and when you add one of the
* relationships the opposite will automatically appear for you in queries.
* The 'hypernym' can be read as 'is a parent of' so:
* 'food' (subject), 'hypernym' (predicate), 'honey' (object)
* Can more easily be read as:
* 'food' is a parent of 'honey'
* 3) The 'synonym' relation defines two concepts that essential mean the same thing. This
* is more like a "is" relationship. So for example a 'synonym' relationship could be:
* "puppy" is "pup"
* The reverse is also true once the former is added so:
* "pup" is "puppy"
* will appear in queries as well.
*
*
* string predicate = 4;
* @return The bytes for predicate.
*/
com.google.protobuf.ByteString
getPredicateBytes();
/**
*
* The knowledge graph id that this edge belongs to. If using the app's global knowledge graph
* and not a specific one then this should be the empty string "".
*
*
* string knowledge_graph_id = 5;
* @return The knowledgeGraphId.
*/
java.lang.String getKnowledgeGraphId();
/**
*
* The knowledge graph id that this edge belongs to. If using the app's global knowledge graph
* and not a specific one then this should be the empty string "".
*
*
* string knowledge_graph_id = 5;
* @return The bytes for knowledgeGraphId.
*/
com.google.protobuf.ByteString
getKnowledgeGraphIdBytes();
/**
*
* 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 = 6;
* @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 = 6;
* @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 = 6;
*/
com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();
}