KnowledgeGraph

classarcgis.graph.KnowledgeGraph(url:str,*,gis=None)

Provides access to the Knowledge Graph service data model and properties, as well asmethods to search and query the graph.

Parameter	Description
url	Knowledge Graph service URL
gis	an authenticatedGIS object.

# Connect to a Knowledge Graph service:gis=GIS(url="url",username="username",password="password")knowledge_graph=KnowledgeGraph(url,gis=gis)

apply_edits(adds:Sequence[dict[str,Any]|Entity|Relationship]=[],updates:Sequence[dict[str,Any]|Entity|Relationship]=[],deletes:Sequence[dict[str,Any]|EntityDelete|RelationshipDelete]=[],input_transform:dict[str,Any]|Transform|None=None,cascade_delete:bool=False,cascade_delete_provenance:bool=False,as_dict:bool=True)→dict|ApplyEditsResponse

Allows users to add, update, and deleteEntity andRelationship.

Note

objectid values are not supported in dictionaries for apply_edits

Parameter	Description
adds	Optional list ofEntity orRelationship. The list ofobjects to add to the graph, represented in dictionary format.
updates	Optional list ofEntity orRelationship. The list ofexistent graph objects that are to be updated, representedin dictionary format.
deletes	Optional list ofEntityDelete orRelationshipDelete. The listof existent objects to remove from the graph, represented indictionary format.
input_transform	OptionalTransform.Allows a user to specify custom quantization parameters for inputgeometry, which dictate how geometries are compressed andtransferred to the server. Defaults to lossless WGS84 quantization.
cascade_delete	Optional boolean. WhenTrue, relationships connected toentities that are being deleted will automatically be deletedas well. WhenFalse, these relationships must be deletedmanually first. Defaults toFalse.
cascade_delete_provenance	Optional boolean. WhenTrue, deleting entities/relationshipsor setting their property values to null will result inautomatic deletion of associated provenance records. WhenFalse,apply_edits() will fail if there are provenancerecords connected to entities/relationships intended fordeletion or having their properties set to null.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

fromarcgis.graphimportEntity,Relationshipadd_entity=Entity(type_name="Company",properties={"name":"Esri"})delete_relationship=DeleteRelationship(type_name="WorksAt",ids=[UUID("783bd422-3hfp-45c7-87aa-8adbbdac0a3d")])graph.apply_edits(adds=[add_entity],deletes=[delete_relationship],as_dict=False)

Returns:

ApplyEditsResponse

constraint_rule_adds(rules:Sequence[dict[str,Any]|ConstraintRule],as_dict:bool=True)→dict|ConstraintRuleAddsResponse

Adds constraint rules for entities & relationships to the data model.RelationshipExclusionRule is a constraint rule.

Parameter	Description
rules	Required Sequence ofRelationshipExclusionRule.Defines the constraint rules to be added.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

fromarcgis.graphimportRelationshipExclusionRulegraph.constraint_rule_adds(rules=[RelationshipExclusionRule(name="OnlyPersonCanWorkAtCompany",origin_entity_types=SetOfNamedTypes(set_complement=["Person"]),relationship_types=SetOfNamedTypes(set=["WorksAt"]),destination_entity_types=SetOfNamedTypes(set=["Company"]))],as_dict=False)

Returns:

ConstraintRuleAddsResponse

constraint_rule_deletes(rule_names:Sequence[str],as_dict:bool=True)→dict|ConstraintRuleDeletesResponse

Deletes existing constraint rules for entities & relationships from the data model.RelationshipExclusionRule is a constraint rule.

Parameter	Description
rule_names	Required Sequence of strings. The names of the constraint rules tobe deleted, as defined in a rule’s ‘name’ attribute.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

# Delete a constraint rule from the Knowledge Graph's data model.graph.constraint_rule_deletes(["constraint_rule_1"],as_dict=False)

Returns:

ConstraintRuleDeletesResponse

constraint_rule_updates(rules:Sequence[dict[str,Any]|ConstraintRuleUpdate],as_dict:bool=True)→dict|ConstraintRuleUpdatesResponse

UpdateConstraintRule for entities & relationships in the data model.RelationshipExclusionRule is a type of constraint rule.

Parameter	Description
rules	Required Sequence ofRelationshipExclusionRuleUpdate.Defines the constraint rules to be updated.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

fromarcgis.graphimportRelationshipExclusionRuleUpdate,ConstraintRule,ConstraintRuleMask,UpdateSetOfNamedTypesgraph.constraint_rule_updates(rules=[RelationshipExclusionRuleUpdate(rule_name="OnlyPersonCanWorkForCompany",mask=ConstraintRuleMask(update_name=True,update_alias=True),constraint_rule=ConstraintRule(name="PersonCanWorkForCompanyOrPark",alias="Person Can Work For Company or Park"))],as_dict=False)

Returns:

ConstraintRuleUpdatesResponse

propertydatamodel:dict

Returns the datamodel for the Knowledge Graph service

Returns:

dict

classmethodfromitem(item)

Returns the Knowledge Graph service from an Item

graph_property_adds(type_name:str,graph_properties:Sequence[dict[str,Any]|GraphProperty],as_dict:bool=True)→dict|PropertyAddsResponse

Adds set ofGraphProperty to a named type in the data model

Learn more about adding properties in a knowledge graph

Parameter	Description
type_name	Required string. The entity or relationship type to which theproperties will be added.
graph_properties	Required Sequence ofGraphProperty.The Sequence of properties to add to the named type.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

fromarcgis.graphimportGraphPropertygraph.graph_property_adds(type_name="Vehicle",graph_properties=[GraphProperty(name="year")])

Returns:

PropertyAddsResponse

graph_property_delete(type_name:str,property_name:str,as_dict:bool=True)→dict|PropertyDeleteResponse

Delete aGraphProperty for a named type in the data model

Learn more about deleting properties in a knowledge graph

Parameter	Description
type_name	Required string. The entity or relationship type containingthe property to be deleted.
property_name	Required string. The property to be deleted.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

# Delete a named type's property in the data modeldelete_result=knowledge_graph.graph_property_delete("Person","Address",as_dict=False)

Returns:

PropertyDeleteResponse

graph_property_index_adds(type_name:str,field_indexes:Sequence[dict[str,Any]|FieldIndex],as_dict:bool=True)→dict|IndexAddsResponse

Adds one or moreFieldIndex to a field or multiple fieldsassociated with a named type in the data model.

Learn more about adding graph property indexes in a knowledge graph

Parameter	Description
type_name	Required string. The entity or relationship type to add theindexes to.
field_indexes	Required list of dicts. The indexes to add for the type.See below for an example of the structure.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

fromarcgis.graphimportFieldIndexgraph.graph_property_index_adds(type_name="Person",field_indexes=[FieldIndex(name="name_index",is_ascending=True,is_unique=False,fields=["name"])],as_dict=False)

Returns:

IndexAddsResponse

graph_property_index_deletes(type_name:str,field_indexes:Sequence[str],as_dict:bool=True)→dict|IndexDeletesResponse

Deletes one or moreFieldIndex from fieldsassociated with a named type in the data model.

Learn more about deleting graph property indexes from a knowledge graph

Parameter	Description
type_name	Required string. The entity or relationship type to delete thefield indexes from.
field_indexes	Required Sequence of strings. The field indexes to delete from thetype.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

# Delete field indexes from a Knowledge Graph typedelete_result=graph.graph_property_index_deletes("Project",["title"],as_dict=False)

Returns:

IndexDeletesResponse

graph_property_update(type_name:str,property_name:str,graph_property:dict[str,Any]|GraphProperty,mask:dict[str,Any]|GraphPropertyMask,as_dict:bool=True)→dict|PropertyUpdateResponse

Updates aGraphProperty for a named type in the data model

Learn more about updating properties in a knowledge graph

Parameter	Description
type_name	Required string. The entity or relationship type containingthe property to be updated.
property_name	Required string. The property to be updated.
graph_property	RequiredGraphProperty.The graph property to be updated.
mask	RequiredGraphPropertyMask.The properties of the field to be updated.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

fromarcgis.graphimportGraphProperty,GraphPropertyMaskgraph.graph_property_update(type_name="Vehicle",property_name="year",graph_property=GraphProperty(name="year",alias="year_made"),mask=GraphPropertyMask(update_alias=True),as_dict=False)

Returns:

PropertyUpdateResponse

named_object_type_adds(entity_types:Sequence[dict[str,Any]|EntityType]=[],relationship_types:Sequence[dict[str,Any]|RelationshipType]=[],as_dict:bool=True)→dict|NamedObjectTypeAddsResponse

AddsEntityType andRelationshipTypeto the data model

Learn more about adding named types to a knowledge graph

Parameter	Description
entity_types	Optional list of EntityTypes. The list of entity typesto add to the data model, represented in dictionary format.
relationship_types	Optional list of RelationshipTypes. The list ofrelationship types to add to the data model, represented indictionary format.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

fromarcgis.graphimportEntityType,RelationshipType,GraphPropertyentity_type_add=EntityType(name="Vehicle",properties={"make":GraphProperty(name="make")})relationship_type_add=RelationshipType(name="Drives")graph.named_object_type_adds(entity_types=[entity_type_add],relationship_types=[relationship_type_add],as_dict=False)

Returns:

NamedObjectTypeAddsResponse

named_object_type_delete(type_name:str,as_dict:bool=True)→dict|NamedObjectTypeDeleteResponse

Deletes anEntityType orRelationshipType in the data model

Learn more about deleting named types in a knowledge graph

Parameter	Description
type_name	Required string. The named type to be deleted.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

# Delete a named type in the data modeldelete_result=graph.named_object_type_delete("Person")

Returns:

NamedObjectTypeDeleteResponse

named_object_type_update(type_name:str,named_type_update:dict[str,Any]|EntityType|RelationshipType,mask:dict[str,Any]|NamedObjectTypeMask,as_dict:bool=True)→dict|NamedObjectTypeUpdateResponse

Updates anEntityType orRelationshipType in the data model

Learn more about updating named types in a knowledge graph

Parameter	Description
type_name	Required string. The named type to be updated.
named_type_update	Required Union[EntityType,RelationshipType]. The entity orrelationship type to be updated.
mask	RequiredNamedObjectTypeMask.The properties of the named type to be updated.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

fromarcgis.graphimportEntityType,NamedObjectTypeMasktype_update=EntityType(name="Vehicle",alias="Car")graph.named_object_type_update(type_name="Vehicle",named_type_update=type_update,mask=NamedObjectTypeMask(update_alias=True),as_dict=False)

Returns:

NamedObjectTypeUpdateResponse

propertyproperties:InsensitiveDict

Returns the properties of the Knowledge Graph service

query(query:str)→List[dict]

Deprecated since version 2.4.1:Removed in: 3.0.0. Use query_streaming instead.

Deprecated since version 2.4.1:Removed in: 3.0.0. Use query_streaming instead.

Queries the Knowledge Graph using openCypher

Learn more about querying a knowledge graph

Parameter	Description
query	Required String. Allows you to return the entities andrelationships in a graph, as well as the properties of thoseentities and relationships, by providing an openCypher query.

# Perform an openCypher query on the knowledge graphquery_result=knowledge_graph.query("MATCH path = (n)-[r]-(n2) RETURN path LIMIT 5")

Returns:

List[list]

query_data_model(as_dict:bool=True)→dict|GraphDataModel

Returns the datamodel for the Knowledge Graph service

Parameter	Description
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

# Query knowledge graph data modelknowledge_graph.query_data_model(as_dict=False)

Returns:

GraphDataModel

query_streaming(query:str,input_transform:dict[str,Any]|Transform|None=None,bind_param:dict[str,Any]={},include_provenance:bool=False,as_dict:bool=True)→Generator[Sequence[Any],None,None]

Query the graph using an openCypher query. Allows for more customization than the basequery() function. Creates a generator of the queryresults, from which users can access each row or add them to a list.See below for example usage.

Parameter	Description
query	Required String. Allows you to return the entities andrelationships in a graph, as well as the properties of thoseentities and relationships, by providing an openCypher query.
input_transform	Optional dict or Transform. Allows a user to specify custom quantizationparameters for input geometry, which dictate how geometries arecompressed and transferred to the server. Defaults to losslessWGS84 quantization.
bind_param	Optional dict. The bind parameters used to filterquery results. Key of each pair is the string name for it,which is how the parameter can be referenced in the query. Thevalue can be any “primitive” type value that may be found asan attribute of an entity or relationship (e.g., string,double, boolean, etc.), a list, an anonymous object (a dict),or a geometry. Anonymous objects and geometries can be passedin as either their normal Python forms, or following theformat found in Knowledge Graph entries (containing an“_objectType” key, and “_properties” for anonymous objects). Note: Including bind parameters not used in the query willcause queries to yield nothing on ArangoDB based services,while Neo4j based services will still produce results.
include_provenance	Optional boolean. WhenTrue, provenance entities (metadata)will be included in the query results. Defaults toFalse.

# Get a list of all query resultsquery_gen=knowledge_graph.query_streaming("MATCH path = (n)-[r]-(n2) RETURN path LIMIT 5")results=list(gen)# Grab one result at a timequery_gen=knowledge_graph.query_streaming("MATCH path = (n)-[r]-(n2) RETURN path LIMIT 5")first_result=next(query_gen)second_result=next(query_gen)

Returns:

Generator[Sequence[Any], None, None]

search(search:str,category:str='both',as_dict:bool=True)→List[Sequence[Any]]

Allows for the searching of the properties of entities,relationships, or both in the graph using a full-text index.

Learn more about searching a knowledge graph

Parameter	Description
search	Required String. The search to perform on the Knowledge Graph.
category	Optional String. The category is the location of the fulltext search. This can be isolated to either theentities ortherelationships. The default is to look inboth. The allowed values are: both, entities, relationships,both_entity_relationship, and meta_entity_provenance. Both andboth_entity_relationship are functionally the same.
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

Note

Check theservice definition for the Knowledge Graph servicefor valid values of category. Not all services support both and both_entity_relationship.

#Perform a search on the knowledge graphforsearch_resultinknowledge_graph.search("cat",as_dict=False):print(search_result)# Perform a search on only entities in the knowledge graphforsearchentities_resultinknowledge_graph.search("cat","entities",as_dict=False):print(searchentities_result)

Returns:

Generator[Sequence[Any], None, None]

sync_data_model(as_dict:bool=True)→dict|SyncDataModelResponse

Synchronizes the Knowledge Graph Service’s data model with any changes madein the database. Will return any errors or warnings from the sync.

Parameter	Description
as_dict	Optional Boolean. Determines whether the result is returned asa dictionary or an object. The default is True. False is recommended.

# Synchronize the data modelsync_result=knowledge_graph.sync_data_model(as_dict=False)

Returns:

SyncDataModelResponse

update_search_index(adds:dict[str,dict|SearchIndexProperties]={},deletes:dict[str,dict|SearchIndexProperties]={},as_dict:bool=True)→dict|UpdateSearchIndexResponse

Allows users to add or deleteSearchIndexProperties for differentEntityType andRelationshipTypefrom theGraphDataModel. Can only be existent properties for a givenentity/relationship type.

fromarcgis.graphimportSearchIndexPropertiesgraph.update_search_index(adds={"Person":SearchIndexProperties(property_names=["name"])},as_dict=False)

Returns:

UpdateSearchIndexResponse

Data Model Types

Graph Types

Search Types

Response Types