Package ai.onnxruntime

Class OrtSession.Result

java.lang.Object

ai.onnxruntime.OrtSession.Result

All Implemented Interfaces:

AutoCloseable, Iterable<Map.Entry<String,OnnxValue>>

Enclosing class:

OrtSession

public static class OrtSession.Result
extends Object
implements AutoCloseable, Iterable<Map.Entry<String,OnnxValue>>

An AutoCloseable wrapper around a Map containing OnnxValues.

When this is closed it closes all the OnnxValues owned by the result object. If you maintain a reference to a value after this object has been closed it will throw an IllegalStateException upon access.

OnnxValues which are supplied as pinned outputs to a run call are not closed by the close() method. Ownership of each output can be checked with isResultOwner(int).

Method Summary

Modifier and Type	Method	Description
void	close()
OnnxValue	get(int index)	Gets the value from the container at the specified index.
Optional<OnnxValue>	get(String key)	Gets the value from the container assuming it's not been closed.
boolean	isResultOwner(int index)	Gets the value from the container at the specified index.
Iterator<Map.Entry<String,OnnxValue>>	iterator()
int	size()	Returns the number of outputs in this Result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

iterator

public Iterator<Map.Entry<String,OnnxValue>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,OnnxValue>>

get

public OnnxValue get(int index)

Gets the value from the container at the specified index.

Throws IllegalStateException if the container has been closed, and IndexOutOfBoundsException if the index is invalid.

Parameters:

index - The index to lookup.

Returns:

The value at the index.

isResultOwner

public boolean isResultOwner(int index)

Gets the value from the container at the specified index.

Throws IllegalStateException if the container has been closed, and ArrayIndexOutOfBoundsException if the index is invalid.

Parameters:

index - The index to lookup.

Returns:

Is that value owned by this result object?

size

public int size()

Returns the number of outputs in this Result.

Returns:

The number of outputs.

get

public Optional<OnnxValue> get(String key)

Gets the value from the container assuming it's not been closed.

Throws IllegalStateException if the container has been closed.

Parameters:

key - The key to lookup.

Returns:

Optional.of the value if it exists.