PyVGX 3.6 Reference

Sufficient access to a vertex, graph, or other object could not be obtained.

An invalid arc specification was used, or a delete operation could not complete due to locked terminal(s).

Bad configuration or corrupted data found.

The core system was unable to translate between external and internal representations of data.

An unknown, internal error has occurred.

A system management operation could not be completed.

Internal error encountered during plugin execution.

A graph query is invalid.

Incorrect parameters or invalid data encountered when processing a PluginRequest object.

Incorrect parameters or invalid data encountered when processing a PluginResponse object.

A result could not be generated after query completion.

The execution of a graph query failed due to an internal error.

A vertex was assigned an invalid name, type, or other attribute.

Accumulate the floating point value for M_ACC arc of type relationship from initial to terminal (names or writable vertex objects.) The accumulation value is specified by delta parameter, which defaults to 1.0. Negative delta is allowed. If the arc does not exist it is created with a value equal to delta. An optional timeout (in milliseconds) allows blocking while waiting for vertex access. The default is nonblocking. Returns the new floating point value of the arc after accumulation has been applied.

Return True if the vertex id (name or readable vertex object) has a neighbor matching arc, neighbor and filter query conditions, otherwise return False. Evaluation of filter may optionally use the specified memory object (advanced use case.) By default this method will not block. Optional timeout (in milliseconds) and hard execution limit limexec can be specified. See Adjacent() for details.

Perform aggregation of property values in the neighborhood of id (name or readable vertex object.) See Aggregate() for usage.

Return the value of an explicit connection from initial to terminal (names or readable vertex objects) matching the specified arc filter. The optional timeout (in milliseconds) allows blocking while waiting for vertex access, or sets an upper execution time limit when limexec is true. The default is nonblocking without execution limit. See ArcValue() for details.

Perform a global arc search in the graph. See Arcs() for usage.

Make a readonly graph writable. OperationTimeout is raised if the graph cannot become writable at this time.

Close graph instance. This has the same effect as using the del operator on the Python graph instance.

Close all vertices opened by the current thread.

Release the vertex_object access lock. Returns True if lock was released, False otherwise. Although the Python vertex_object object still exists it can no longer be used to access the graph. Deleting vertex_object using Python’s del operator, or waiting for vertex_object to go out of scope implicitly releases the vertex lock.

Release one lock for each vertex object in vertex_objects list. Returns the number of vertices for which a lock was released, which may be less than the length of vertex_objects if any of those vertices were already released.

Commit modifications to all write-locked vertices owned by the current thread, and keep vertices open. Return the number of write-locked vertices.

Create explicit connection(s) between vertices by inserting an arc from the initial vertex to each vertex in terminals, which may be a list or a singleton. A vertex may be given as a string (vertex ID) or a writable vertex object.

Increment the integer value for M_CNT arc of type relationship from initial to terminal (names or writable vertex objects.) The increment value is specified by delta parameter, which defaults to 1. Negative delta is allowed. If the arc does not exist it is created with a value equal to delta. An optional timeout (in milliseconds) allows blocking while waiting for vertex access. The default is nonblocking. Returns the new integer value of the arc after increment has been applied.

Create a new vertex identified by id and with optional type. An optional lifespan (in seconds) may be specified to trigger automatic vertex deletion when the vertex reaches the maximum age (which is infinite by default.) A dict of { str : object } pairs may be passed in properties to initialize or update the vertex properties. Returns 1 if the vertex is created, 0 if the vertex already exists.

Perform allocator consistency checks. By default all allocators are checked. Select a specific allocator with name. This method returns None. If internal allocator problems are detected an exception is raised.

Print internal graph information.

Return a representation of an internal object identified by string identifier.

Return a representation of an internal object located at memory address.

Print internal allocator information to stdout. By default all allocators are dumped. Select a specific allocator with name.

Create a new function formula that can be used by queries for filtering and ranking. The expression parameter is a string of the form <name> := <formula>. See Define() for details.

Return the number of arcs incident on id (name or readable vertex object) matching the optional arc and filter conditions. The optional timeout (in milliseconds) allows blocking while waiting for vertex access, or sets an upper execution time limit when limexec is true. The default is nonblocking without execution limit. See Degree() for details.

Remove the vertex identified by id from the graph. An optional timeout (in milliseconds) can be specified to wait for vertex access in case it may be in use by other threads.

Feature vectors: Return vector dimension associated with enumeration code if mapping exists, otherwise raise EnumerationError.

Remove one or more explicit connections incident on the specified id (name or writable object). The optional arc and neighbor filters are used to limit arc removal to only those arcs matching the filter criteria. An optional timeout (in milliseconds) allows blocking while waiting for necessary graph access to be obtained. Returns the number of arcs removed.

Feature vectors: Return enumeration code for vector dimension dim after defining mapping if it does not already exist.

Return enumeration code for property key after defining mapping if it does not already exist.

Return enumeration code for relationship type rel after defining mapping if it does not already exist.

Return enumeration code for property key after defining mapping if it does not already exist.

Return enumeration code for vertex type vtype after defining mapping if it does not already exist.

Remove all graph data from memory and disk. Only a basic file structure for the graph will remain.

Promote acquisition status from readonly to writable for readonly_vertex_object without intermittent release. An optional timeout (in milliseconds) allows blocking while waiting for writable access to be obtained. The default is nonblocking. If the vertex is already writable or the readonly vertex cannot be acquired writable AccessError is raised. This method returns nothing.

Execute the expression, which is a string defining a new formula, or referencing a pre-defined formula. The optional parameters are used to supply information that may be referenced in the formula. See Evaluate() for details.

Return a string representing the current state of the internal event processor.

Disable the internal event processor. This halts the time-to-live processing of vertices and arcs, i.e. TTL will be disabled.

Start the internal event processor. This resumes the time-to-live processing of vertices and arcs, i.e. TTL will be enabled.

Manually move all pending internal events from queues to their respective schedules. The method is provided for debugging purposes.

Return a dictionary of parameters currently in effect for the event processor.

Return the expression string of previously defined formula name.

Return a list of all previously defined formulas.

Return current memory usage information for graph.

Return a list of all of this graph’s vertices currently acquired by all threads (the default), or by a single thread specified by threadid.

Return a pyvgx.Vertex object identified by id in readonly mode.

Return the identifier string for the vertex specified by its internal integer offset. If offset is not specified return the identifier string of a random vertex in the graph. Vertices are enumerated by offsets in the range [0, order-1]. A negative offset counts from the end. Out of range offsets raise IndexError.

Return True if vertex identified by id exists in this graph, otherwise return False.

Return a list of all outarcs of id (name or readable object), up to a maximum of hits entries. The default is to return all outarcs. The optional timeout (in milliseconds) allows blocking while waiting for vertex access, or sets an upper execution time limit when limexec is true. The default is nonblocking without execution limit.

Return a list of vertex names of all vertices with explicit connection(s) to the vertex id (name or readable object), optionally filtered and sorted as specified by other parameters. See Initials() for details.

Return True if the graph is local only, otherwise False.

Return True if the graph is currently readonly, otherwise False.

Return property key associated with enumeration code if mapping exists, otherwise raise EnumerationError.

Acquire and return a mutex lock object. All arguments are optional.

Return a new pyvgx.Memory object associated with this graph. See Evaluator Memory for usage details.

Perform a neighborhood search in the graph starting at id (name or readable vertex object.) See Neighborhood() for usage.

Create a new reusable pyvgx.Query object for performing adjacency tests in the graph. This methods takes the same arguments as pyvgx.Graph.Adjacent(), except for timeout and limexec which are instead specified as arguments to pyvgx.Query.Execute(). It is possible to omit the id argument (anchor vertex) when creating the query object, but pyvgx.Query.id needs to be assigned before calling pyvgx.Query.Execute().

Create a new reusable pyvgx.Query object for performing aggregations in the graph. This methods takes the same arguments as pyvgx.Graph.Aggregate(), except for timeout and limexec which are instead specified as arguments to pyvgx.Query.Execute(). It is possible to omit the id argument (anchor vertex) when creating the query object, but pyvgx.Query.id needs to be assigned before calling pyvgx.Query.Execute().

Create a new reusable pyvgx.Query object for performing global arc searches in the graph. This methods takes the same arguments as pyvgx.Graph.Arcs(), except for hits, offset, timeout, and limexec which are instead specified as arguments to pyvgx.Query.Execute().

Create a new reusable pyvgx.Query object for performing neighborhood searches in the graph. This methods takes the same arguments as pyvgx.Graph.Neighborhood(), except for hits, offset, timeout, and limexec which are instead specified as arguments to pyvgx.Query.Execute(). It is possible to omit the id argument (anchor vertex) when creating the query object, but pyvgx.Query.id needs to be assigned before calling pyvgx.Query.Execute().

Return a pyvgx.Vertex object identified by id. An optional type may be specified. An optional lifespan (in seconds) may be specified to trigger automatic vertex deletion when the vertex reaches the maximum age (which is infinite by default.) A dict of { str : object } pairs may be passed in properties to initialize or update the vertex properties. If the vertex does not already exist it is created and committed. The returned vertex is acquired in the writable state. By default this method will not block. An optional timeout (in milliseconds) can be specified.

Create a new reusable pyvgx.Query object for performing global vertex searches in the graph. This methods takes the same arguments as pyvgx.Graph.Vertices(), except for hits, offset, timeout, and limexec which are instead specified as arguments to pyvgx.Query.Execute().

Acquire and return one of the neighbors of vertex id, optionally filtered by arc. The returned pyvgx.Vertex object will be acquired according to mode, which may be 'r' (the default) or 'a'. The optional timeout (in milliseconds, default=0) allows blocking while waiting for vertex access.

Acquire and return a pyvgx.Vertex object identified by id, which may be a string or a memory address. Use the optional mode parameter to control how the vertex is acquired. Acquisition is recursive. Mode 'w' acquires the vertex writable after implicitly creating and committing the vertex if it does not already exist. Mode 'r' acquires an already existing vertex readonly. Mode 'a' (the default) acquires the vertex writable without creating. Supplying an integer id (memory address) is only supported for modes 'r' and 'a'.

Acquire and return multiple pyvgx.Vertex objects identified by strings or vertex instances in idlist. Use the optional mode parameter to control how the vertices are acquired. Acquisition is recursive. Mode 'r' acquires vertices readonly. Mode 'a' (the default) acquires vertices writable. All vertices must be acquired for this method to succeed. If one or more vertices cannot be acquired AccessError is raised.

Return the number of vertices in the graph, optionally restricted to vertices of the specified type.

Return a list of all inarcs of id (name or readable object), up to a maximum of hits entries. The default is to return all inarcs. The optional timeout (in milliseconds) allows blocking while waiting for vertex access, or sets an upper execution time limit when limexec is true. The default is nonblocking without execution limit.

Return dict of all existing property key mappings.

Return dict of all existing property string value mappings.

Return relationship type associated with enumeration code if mapping exists, otherwise raise EnumerationError.

Return dict of all existing relationship mappings.

Relax acquisition status from writable to readonly for writable_vertex_object without intermittent release, then return True. If vertex was acquired writable more than once then this method has the same effect as CloseVertex() and False is returned. This method will never block.

Reset query counters.

Force the graph input serial number to 0, or to sn if provided. This allows already consumed operation data to be re-submitted.

Persist the graph to disk. An optional timeout (in milliseconds) allows blocking while waiting for the entire graph to become idle in order for the operation to proceed. The default is 1000. Data is normally saved incrementally, i.e. only modified structures are written to disk. To perform a complete serialization set force to True. Remote destinations will be notified about the local persist only if remote is set to True (default is False.)

Perform a generic graph search and print the results in human readable form to stdout. See Search() for usage.

Make the graph readonly. An optional timeout (in milliseconds) allows blocking while waiting for graph to become idle. The default is nonblocking. OperationTimeout is raised if the graph cannot enter readonly mode. No vertices can be acquired writable when a graph is readonly. However, queries are still allowed.

Print a summary of all of this graph’s vertices currently acquired by all threads.

Print a representation of internal data for the vertex identified by id. This method does not block by default. An optional timeout may be specified.

Return the number of explicit connections in the graph.

Return a dictionary of various information, counters, and resource usage for the graph.

Update data on all attached destinations to match this VGX source instance. When the optional parameter hard (bool) is True the destination VGX instances are truncated before they are re-populated with data from the source. The default is hard=False, which means the destinations are not truncated prior to receiving the source data.

Call function( *args, **kwds ) in a synchronized context and return its returned value. Only one thread of execution will be allowed to perform a synchronized call at a time, even if the called functions are different.

Return a list of vertex names of all vertices with explicit connection(s) from the vertex id (name or readable object), optionally filtered and sorted as specified by other parameters. See Terminals() for details.

Delete all graph data, or if type is specified erase all vertices of that type. All arcs incident on the removed vertices will also be removed.

Return property string value associated with enumeration code if mapping exists, otherwise raise EnumerationError.

Return a string representing internal descriptor data for the vertex identified by id.

Return the identifier of vertex at memory address.

Return vertex type associated with enumeration code if mapping exists, otherwise raise EnumerationError.

Return dict of all existing vertex type mappings.

Perform a global vertex search in the graph. See Vertices() for usage.

Return a list of names of all vertices of the given type in this graph.

Shorthand for pyvgx.Graph.Adjacent( id, …​ ) where id is implied.

Shorthand for pyvgx.Graph.Aggregate( id, …​ ) where id is implied.

Return 32 lsh bits from a region of the 64-bit LSH not overlapping with LSH segment used to generate a projection key

Shorthand for pyvgx.Graph.ArcValue( initial, …​ ) where initial is implied.

Return a dictionary representation of the vertex.

Remove any TTL expiration for this vertex.

Release vertex access lock.

Commit all vertex modifications and mark vertex object as dirty. This has the same effect as CloseVertex() but without releasing the lock. Returns the graph operation id.

Print various internal vertex object information. _

Shorthand for pyvgx.Graph.Degree( id, …​ ) where id is implied.

Return a string representation of the vertex descriptor.

Promote vertex acquisition status from readonly to writable. An optional timeout (in milliseconds) allows blocking while waiting for writable access to be obtained. The default is nonblocking. If the vertex is already writable or the readonly vertex cannot be acquired writable AccessError is raised.

Return the vertex expiration time in seconds since 1970.

Return all vertex properties as a dictionary.

Return the value of vertex property name. If the property does not exist the default value is returned. If no default is specified, None is returned.

Return the currently assigned ranking coefficients.

Return the vertex type.

Return the vertex type enumeration code.

Return a pyvgx.Vector object representing the similarity vector assigned to vertex. If vertex has no similarity vector a null-vector is returned.

Return True if vertex has any properties, False otherwise.

Return True if the vertex has a property called name optionally matching value_filter, otherwise False.

Return True if the vertex has a similarity vector, otherwise False.

Shorthand for pyvgx.Graph.Inarcs( id, …​ ) where id is implied.

Increment the vertex property name by numeric increment value, which defaults to 1. Positive and negative numbers are allowed. If the property does not exist it is created and initialized to increment. The resulting value of property name after increment is returned.

Shorthand for pyvgx.Graph.Initials( id, …​ ) where id is implied.

Return True if this vertex has an expiration timestamp in the past, otherwise False. It is possible for the vertex to be expired and not deleted if it is currently in use.

Return True if the vertex is virtual. Return False if the vertex is real.

Return a list of all key-value pairs for all properties of this vertex.

Return a list of all property names of this vertex.

Shorthand for pyvgx.Graph.Neighborhood( id, …​ ) where id is implied.

Shorthand for combining the results of Initials( …​ ) and Terminals( …​ ) into one list.

Return the number of properties for this vertex.

Shorthand for pyvgx.Graph.OpenNeighbors( id, …​ ) where id is implied.

Shorthand for pyvgx.Graph.Outarcs( id, …​ ) where id is implied.

Return True if vertex object has access to the graph (writable or readonly), otherwise False.

Return True if vertex object is readonly, otherwise False.

Relax vertex acquisition status from writable to readonly. Return True if vertex was relaxed. Return False if vertex is still writable.

Remove all properties for this vertex.

Delete the vertex property name. LookupError is raised if the property does not exist.

Remove the similarity vector from vertex if one exists.

Schedule the vertex for automatic deletion (time-to-live). If relative is False (the default), expires is an absolute timestamp in seconds since 1970. If relative is True, expires is a number of seconds into the future relative to the current time.

Set multiple vertex properties provided in dictionary dict.

Assign a property name to the vertex. If no value is supplied it defaults to None. Acceptable values are numbers, strings, lists of numeric values, dicts of {int:float} items, or any Python object supporting the Pickle protocol. This method does not return anything.

Assign dynamic rank coefficients to vertex for use in ranking expressions. The normal use of these coefficients is for evaluating the linear ranking function rank() = c1 ⋅ ∑x + c0, but can also be used for other ranking functions where they take on different meanings depending on context (such as c1=latitude, c0=longitude for the georank() function). It is also possible to use c1 and c0 as light-weight general purpose numeric properties.

Change the vertex type.

Assign a similarity vector to this vertex. The vector is generated from dimension-weight pairs (feature vector) or floating point values (euclidean vector) in elements. Any previous vector is removed and replaced by a new vector.

Shorthand for pyvgx.Graph.Terminals( id, …​ ) where id is implied.

Return a list of all property values of this vertex.

Return True if vertex object is writable, otherwise False.

Return a new list object from the memory object’s data. Other ways to achieve the same are list( memobj ) and memobj[:].

Convert between packed and unpacked 2-tuple of unsigned 32-bit integer values as follows:

Initialize all elements of the memory array to value, optionally incrementing the value of each successive element by increment. Both parameters must be numeric (integer or floating point.) This also resets the stack pointer and cleans up all previously assigned string objects. Note that all elements of the memory array are affected, including registers R1 - R4.

Sort the elements in the specified range [start, end-1] using an element comparator automatically chosen according to the type of the element at index start. By default, start = 0, end = R4, reverse = False.

Return a new list object containing the values currently pushed on the memory stack. (The stack pointer can only be manipulated in evaluator expressions using push/pop operations.)

Return a dictionary representation of the vector.

Print an internal representation of the vector to stdout.

Return a 64-bit fingerprint representing the vector. Different values for seed (default 0) will result in alternative projections of the n-dimensional vector onto 64-dimensional binary space. Fingerprints are proxies for vector direction only, and are thus insensitive to vector magnitude.

Return the vector’s LSH, "low confidence mask", and index projections for a given seed.

Return a dictionary containing all the configuration attributes of the similarity object.

Return the cosine similarity of two vectors v1 and v2.

Initialize a graph structure used for approximate nearest neighbor (ANN) vector search. Parameter nseeds specifies the number of sets, and ksize specifies the number of bits per projection key.

Destroy graph structure previously created by CreateProjectonSets().

Return the Euclidean distance between two vectors v1 and v2.

Return a 64-bit fingerprint for vector (instance or element list.) The default seed = 0. Different values for seed will result in alternative projections of the n-dimensional vector onto 64-dimensional binary space.

Return the number of differing bits (0 - 64) in the fingerprints of vectors v1 and v2. The vector fingerprint is a 64-bit integer representing the vector, i.e. a dimensionality reduced representation of the vector. Similar vectors will generally have similar fingerprints and the number of differing bits will be small.

Return the weighted jaccard similarity (0.0 - 1.0) of two vectors v1 and v2. The jaccard similarity measures the relative amount of overlap between the two vectors. Vectors interpreted as sets rather than geometric objects in this context, i.e. the jaccard similarity can be much less than 1.0 even if the vectors are completely aligned, if their magnitudes are different.

Return a new centroid vector computed from vectors in vector_list.

Return a new vector associated with this similarity object, setting the vector elements according to elements_list.

Return list of projection names [b'_xxxx|xxx', …​].

Return a new, random Euclidean vector with n dimensions.

Return the similarity score for two vectors v1 and v2. The similarity score is computed as cosine(v1, v2)^cosine_exp * jaccard(v1,v2)^jaccard_exp. The returned value is in the range 0.0 - 1.0.