ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Core.Data.Knowledge Namespace / KnowledgeGraphNamedTypeCategory Enumeration
Example Example

In This Topic
    KnowledgeGraphNamedTypeCategory Enumeration
    In This Topic
    Represents the category of a named type. The default is unspecified. Other options include entity, relationship, both entity and relationship, and provenance. Currently used to communicate search targets.

    The categories supported by the Knowedge Graph is determined by KnowledgeGraph.GetSupportedSearchTargets.
    Syntax
    public enum KnowledgeGraphNamedTypeCategory : System.Enum, System.IComparable, System.IConvertible, System.IFormattable  
    Public Enum KnowledgeGraphNamedTypeCategory 
       Inherits System.Enum
       Implements System.IComparable, System.IConvertible, System.IFormattable 
    Members
    MemberDescription
    BothEntityRelationship Both entity and relationship.
    Entity Entity.
    Provenance Provenance.
    Relationship Relationship.
    Unspecified Unspecified.
    Example
    Submit a Text Search
    //On the QueuedTask...
    //and assuming you have established a connection to a knowledge graph
    //...
    //Construct a KG search filter. Search text uses Apache Lucene Query Parser
    //syntax - https://lucene.apache.org/core/2_9_4/queryparsersyntax.html
    var kg_sf = new KnowledgeGraphSearchFilter()
    {
      SearchTarget = KnowledgeGraphNamedTypeCategory.Entity,
      SearchText = "Acme Electric Co.",
      ReturnSearchContext = true,
      MaxRowCount = 10 //Default is 100 if not specified
    };
          
    //submit the search - returns a KnowledgeGraphCursor
    using (var kg_rc = kg.SubmitSearch(kg_sf))
    {
      //wait for rows to be returned from the server
      //note the "await"...
      while (await kg_rc.WaitForRowsAsync())
      {
        //Rows have been retrieved - process this "batch"...
        while (kg_rc.MoveNext())
        {
          //Get the current KnowledgeGraphRow
          using (var graph_row = kg_rc.Current)
          {
            //Graph row is an array, process all returned values...
            var val_count = (int)graph_row.GetCount();
            for (int i = 0; i < val_count; i++)
            {
              var retval = graph_row[i];
              //Process row value (note: recursive)
              //See "Process a KnowledgeGraphRow Value" snippet
              ProcessKnowledgeGraphRowValue(retval);
            }
          }
        }
      }//WaitForRowsAsync
    }//SubmitSearch
    Inheritance Hierarchy

    System.Object
       System.ValueType
          System.Enum
             ArcGIS.Core.Data.Knowledge.KnowledgeGraphNamedTypeCategory

    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3.2 or higher.
    See Also