OrtApi class final

\brief The C API

All C API functions are defined inside this structure as pointers to functions. Call OrtApiBase::GetApi to get a pointer to it

\nosubgrouping

Inheritance

Object
Struct
OrtApi

Implemented types

NativeType

Available extensions

StructAddress

Constructors

OrtApi()

Properties

AddCustomOpDomain ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtCustomOpDomain> custom_op_domain)>>: \brief Add custom op domain to a session options
getter/setter pair
AddExternalInitializers ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Pointer<Char>> initializer_names, Pointer<Pointer<OrtValue>> initializers, Size num_initializers)>>: \brief Replace initialized Tensors with external data with the data provided in initializers.
getter/setter pair
AddExternalInitializersFromFilesInMemory ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Pointer<Char>> external_initializer_file_names, Pointer<Pointer<Char>> external_initializer_file_buffer_array, Pointer<Size> external_initializer_file_lengths, Size num_external_initializer_files)>>: \brief Replace initialized Tensors with external data with the provided files in memory
getter/setter pair
AddFreeDimensionOverride ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> dim_denotation, Int64 dim_value)>>: \brief Override session symbolic dimensions
getter/setter pair
AddFreeDimensionOverrideByName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> dim_name, Int64 dim_value)>>: Override symbolic dimensions (by specific name strings) with actual values if known at session initialization time to enable optimizations that can take advantage of fixed values (such as memory planning, etc)
getter/setter pair
AddInitializer ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> name, Pointer<OrtValue> val)>>: \brief Add a pre-allocated initializer to a session
getter/setter pair
AddKeyValuePair ↔ Pointer<NativeFunction<Void Function(Pointer<OrtKeyValuePairs> kvps, Pointer<Char> key, Pointer<Char> value)>>: \brief Add a key-value pair to the OrtKeyValuePairs instance.
getter/setter pair
address → Pointer<T>: Available on T, provided by the StructAddress extension
The memory address of the underlying data.
no setter
AddRunConfigEntry ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options, Pointer<Char> config_key, Pointer<Char> config_value)>>: \brief Set a single run configuration entry as a pair of strings
getter/setter pair
AddSessionConfigEntry ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> config_key, Pointer<Char> config_value)>>: \brief Set a session configuration entry as a pair of strings
getter/setter pair
AllocatorAlloc ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtAllocator> ort_allocator, Size size, Pointer<Pointer<Void>> out)>>: \brief Calls OrtAllocator::Alloc function
getter/setter pair
AllocatorFree ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtAllocator> ort_allocator, Pointer<Void> p)>>: \brief Calls OrtAllocator::Free function
getter/setter pair
AllocatorGetInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtAllocator> ort_allocator, Pointer<Pointer<OrtMemoryInfo>> out)>>: \brief Calls OrtAllocator::Info function
getter/setter pair
AllocatorGetStats ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtAllocator> ort_allocator, Pointer<Pointer<OrtKeyValuePairs>> out)>>: \brief Calls OrtAllocator::GetStats function
getter/setter pair
BindInput ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtIoBinding> binding_ptr, Pointer<Char> name, Pointer<OrtValue> val_ptr)>>: \brief Bind an ::OrtValue to an ::OrtIoBinding input
getter/setter pair
BindOutput ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtIoBinding> binding_ptr, Pointer<Char> name, Pointer<OrtValue> val_ptr)>>: \brief Bind an ::OrtValue to an ::OrtIoBinding output
getter/setter pair
BindOutputToDevice ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtIoBinding> binding_ptr, Pointer<Char> name, Pointer<OrtMemoryInfo> mem_info_ptr)>>: \brief Bind an ::OrtIoBinding output to a device
getter/setter pair
CastTypeInfoToMapTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTypeInfo> type_info, Pointer<Pointer<OrtMapTypeInfo>> out)>>: \brief Get detailed map information from an ::OrtTypeInfo
getter/setter pair
CastTypeInfoToOptionalTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTypeInfo> type_info, Pointer<Pointer<OrtOptionalTypeInfo>> out)>>: \brief Get Optional Type information from an ::OrtTypeInfo
getter/setter pair
CastTypeInfoToSequenceTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTypeInfo> type_info, Pointer<Pointer<OrtSequenceTypeInfo>> out)>>: \brief Cast ::OrtTypeInfo to an ::OrtSequenceTypeInfo
getter/setter pair
CastTypeInfoToTensorInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTypeInfo> type_info, Pointer<Pointer<OrtTensorTypeAndShapeInfo>> out)>>: \brief Get ::OrtTensorTypeAndShapeInfo from an ::OrtTypeInfo
getter/setter pair
ClearBoundInputs ↔ Pointer<NativeFunction<Void Function(Pointer<OrtIoBinding> binding_ptr)>>: \brief Clears any previously set Inputs for an ::OrtIoBinding
getter/setter pair
ClearBoundOutputs ↔ Pointer<NativeFunction<Void Function(Pointer<OrtIoBinding> binding_ptr)>>: \brief Clears any previously set Outputs for an ::OrtIoBinding
getter/setter pair
CloneSessionOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> in_options, Pointer<Pointer<OrtSessionOptions>> out_options)>>: \brief Create a copy of an existing ::OrtSessionOptions
getter/setter pair
CompareMemoryInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtMemoryInfo> info1, Pointer<OrtMemoryInfo> info2, Pointer<Int> out)>>: \brief Compare ::OrtMemoryInfo objects for equality
getter/setter pair
CopyKernelInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Pointer<OrtKernelInfo>> info_copy)>>: \brief: Get a copy of kernel info
getter/setter pair
CopyTensors ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Pointer<OrtValue>> src_tensors, Pointer<Pointer<OrtValue>> dst_tensors, Pointer<OrtSyncStream> stream, Size num_tensors)>>: \brief Copy OrtValue instances containing Tensors between devices.
getter/setter pair
CreateAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<OrtMemoryInfo> mem_info, Pointer<Pointer<OrtAllocator>> out)>>: \brief Create an allocator for an ::OrtSession following an ::OrtMemoryInfo
getter/setter pair
CreateAndRegisterAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<OrtMemoryInfo> mem_info, Pointer<OrtArenaCfg> arena_cfg)>>: \brief Create an allocator and register it with the ::OrtEnv
getter/setter pair
CreateAndRegisterAllocatorV2 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Char> provider_type, Pointer<OrtMemoryInfo> mem_info, Pointer<OrtArenaCfg> arena_cfg, Pointer<Pointer<Char>> provider_options_keys, Pointer<Pointer<Char>> provider_options_values, Size num_keys)>>: \brief Create an allocator with specific type and register it with the ::OrtEnv This API enhance CreateAndRegisterAllocator that it can create an allocator with specific type, not just CPU allocator Enables sharing the allocator between multiple sessions that use the same env instance. Lifetime of the created allocator will be valid for the duration of the environment. Returns an error if an allocator with the same ::OrtMemoryInfo is already registered. \paramin env OrtEnv instance \paramin provider_type ExecutionProvider type \paramin mem_info OrtMemoryInfo instance \paramin arena_cfg Arena configuration \paramin provider_options_keys key of the provider options map \paramin provider_options_values value of the provider options map \paramin num_keys Length of the provider options map
getter/setter pair
CreateArenaCfg ↔ Pointer<NativeFunction<OrtStatusPtr Function(Size max_mem, Int arena_extend_strategy, Int initial_chunk_size_bytes, Int max_dead_bytes_per_chunk, Pointer<Pointer<OrtArenaCfg>> out)>>: \deprecated Use OrtApi::CreateArenaCfgV2
getter/setter pair
CreateArenaCfgV2 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<Char>> arena_config_keys, Pointer<Size> arena_config_values, Size num_keys, Pointer<Pointer<OrtArenaCfg>> out)>>: \brief Create an ::OrtArenaCfg
getter/setter pair
CreateCANNProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtCANNProviderOptions>> out)>>: \brief Create an OrtCANNProviderOptions
getter/setter pair
CreateCpuMemoryInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Int type, Int mem_type, Pointer<Pointer<OrtMemoryInfo>> out)>>: \brief Create an ::OrtMemoryInfo for CPU memory
getter/setter pair
CreateCUDAProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtCUDAProviderOptionsV2>> out)>>: \brief Create an OrtCUDAProviderOptionsV2
getter/setter pair
CreateCustomOpDomain ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> domain, Pointer<Pointer<OrtCustomOpDomain>> out)>>: \brief Create a custom op domain
getter/setter pair
CreateDnnlProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtDnnlProviderOptions>> out)>>: \brief Create an OrtDnnlProviderOptions
getter/setter pair
CreateEnv ↔ Pointer<NativeFunction<OrtStatusPtr Function(UnsignedInt log_severity_level, Pointer<Char> logid, Pointer<Pointer<OrtEnv>> out)>>: \brief Create an OrtEnv
getter/setter pair
CreateEnvWithCustomLogger ↔ Pointer<NativeFunction<OrtStatusPtr Function(OrtLoggingFunction logging_function, Pointer<Void> logger_param, UnsignedInt log_severity_level, Pointer<Char> logid, Pointer<Pointer<OrtEnv>> out)>>: \brief Create an OrtEnv
getter/setter pair
CreateEnvWithCustomLoggerAndGlobalThreadPools ↔ Pointer<NativeFunction<OrtStatusPtr Function(OrtLoggingFunction logging_function, Pointer<Void> logger_param, UnsignedInt log_severity_level, Pointer<Char> logid, Pointer<OrtThreadingOptions> tp_options, Pointer<Pointer<OrtEnv>> out)>>: Create a custom environment with global threadpools and logger that will be shared across sessions. Use this in conjunction with OrtApi::DisablePerSessionThreads or else the session will use its own thread pools.
getter/setter pair
CreateEnvWithGlobalThreadPools ↔ Pointer<NativeFunction<OrtStatusPtr Function(UnsignedInt log_severity_level, Pointer<Char> logid, Pointer<OrtThreadingOptions> tp_options, Pointer<Pointer<OrtEnv>> out)>>: \brief Create an OrtEnv
getter/setter pair
CreateEnvWithOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnvCreationOptions> options, Pointer<Pointer<OrtEnv>> out)>>: \brief Create an OrtEnv instance with the given options.
getter/setter pair
CreateExternalInitializerInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> filepath, Int64 file_offset, Size byte_size, Pointer<Pointer<OrtExternalInitializerInfo>> out)>>: \brief Creates an OrtExternalInitializerInfo instance.
getter/setter pair
CreateIoBinding ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Pointer<OrtIoBinding>> out)>>: \brief Create an ::OrtIoBinding instance
getter/setter pair
CreateKeyValuePairs ↔ Pointer<NativeFunction<Void Function(Pointer<Pointer<OrtKeyValuePairs>> out)>>: \brief Create an OrtKeyValuePairs instance.
getter/setter pair
CreateLoraAdapter ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> adapter_file_path, Pointer<OrtAllocator> allocator, Pointer<Pointer<OrtLoraAdapter>> out)>>: \brief Create an OrtLoraAdapter
getter/setter pair
CreateLoraAdapterFromArray ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Void> bytes, Size num_bytes, Pointer<OrtAllocator> allocator, Pointer<Pointer<OrtLoraAdapter>> out)>>: \brief Create an OrtLoraAdapter
getter/setter pair
CreateMemoryInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> name, Int type, Int id, Int mem_type, Pointer<Pointer<OrtMemoryInfo>> out)>>: \brief Create an ::OrtMemoryInfo
getter/setter pair
CreateMemoryInfo_V2 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> name, UnsignedInt device_type, Uint32 vendor_id, Int32 device_id, UnsignedInt mem_type, Size alignment, Int allocator_type, Pointer<Pointer<OrtMemoryInfo>> out)>>: \brief Create an ::OrtMemoryInfo
getter/setter pair
CreateOp ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> op_name, Pointer<Char> domain, Int version, Pointer<Pointer<Char>> type_constraint_names, Pointer<UnsignedInt> type_constraint_values, Int type_constraint_count, Pointer<Pointer<OrtOpAttr>> attr_values, Int attr_count, Int input_count, Int output_count, Pointer<Pointer<OrtOp>> ort_op)>>: \brief: Create onnxruntime native operator
getter/setter pair
CreateOpaqueValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> domain_name, Pointer<Char> type_name, Pointer<Void> data_container, Size data_container_size, Pointer<Pointer<OrtValue>> out)>>: \brief Create an opaque (custom user defined type) ::OrtValue
getter/setter pair
CreateOpAttr ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> name, Pointer<Void> data, Int len, UnsignedInt type, Pointer<Pointer<OrtOpAttr>> op_attr)>>: \brief: Create attribute of onnxruntime operator
getter/setter pair
CreatePrepackedWeightsContainer ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtPrepackedWeightsContainer>> out)>>: \brief Create an ::OrtPrepackedWeightsContainer
getter/setter pair
CreateROCMProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtROCMProviderOptions>> out)>>: \brief Create an OrtROCMProviderOptions
getter/setter pair
CreateRunOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtRunOptions>> out)>>: \brief Create an OrtRunOptions
getter/setter pair
CreateSession ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Char> model_path, Pointer<OrtSessionOptions> options, Pointer<Pointer<OrtSession>> out)>>: \brief Create an OrtSession from a model file
getter/setter pair
CreateSessionFromArray ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Void> model_data, Size model_data_length, Pointer<OrtSessionOptions> options, Pointer<Pointer<OrtSession>> out)>>: \brief Create an OrtSession from memory
getter/setter pair
CreateSessionFromArrayWithPrepackedWeightsContainer ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Void> model_data, Size model_data_length, Pointer<OrtSessionOptions> options, Pointer<OrtPrepackedWeightsContainer> prepacked_weights_container, Pointer<Pointer<OrtSession>> out)>>: \brief Create session from memory with prepacked weights container
getter/setter pair
CreateSessionOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtSessionOptions>> options)>>: \brief Create an ::OrtSessionOptions object
getter/setter pair
CreateSessionWithPrepackedWeightsContainer ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Char> model_path, Pointer<OrtSessionOptions> options, Pointer<OrtPrepackedWeightsContainer> prepacked_weights_container, Pointer<Pointer<OrtSession>> out)>>: \brief Create session with prepacked weights container
getter/setter pair
CreateSharedAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<OrtEpDevice> ep_device, UnsignedInt mem_type, Int allocator_type, Pointer<OrtKeyValuePairs> allocator_options, Pointer<Pointer<OrtAllocator>> allocator)>>: \brief Create/replace a shared allocator for the OrtEpDevice in the OrtEnv.
getter/setter pair
CreateSparseTensorAsOrtValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtAllocator> allocator, Pointer<Int64> dense_shape, Size dense_shape_len, UnsignedInt type, Pointer<Pointer<OrtValue>> out)>>: \brief Create an ::OrtValue with a sparse tensor that is empty.
getter/setter pair
CreateSparseTensorWithValuesAsOrtValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtMemoryInfo> info, Pointer<Void> p_data, Pointer<Int64> dense_shape, Size dense_shape_len, Pointer<Int64> values_shape, Size values_shape_len, UnsignedInt type, Pointer<Pointer<OrtValue>> out)>>: Create an ::OrtValue with a sparse tensor. This is the first step. Next, use Use
getter/setter pair
CreateStatus ↔ Pointer<NativeFunction<Pointer<OrtStatus> Function(UnsignedInt code, Pointer<Char> msg)>>: \brief Create an OrtStatus from a null terminated string
getter/setter pair
CreateSyncStreamForEpDevice ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpDevice> ep_device, Pointer<OrtKeyValuePairs> stream_options, Pointer<Pointer<OrtSyncStream>> stream)>>: \brief Create an OrtSyncStream for the given OrtEpDevice.
getter/setter pair
CreateTensorAsOrtValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtAllocator> allocator, Pointer<Int64> shape, Size shape_len, UnsignedInt type, Pointer<Pointer<OrtValue>> out)>>: \brief Create a tensor
getter/setter pair
CreateTensorRTProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtTensorRTProviderOptionsV2>> out)>>: \brief Create an OrtTensorRTProviderOptionsV2
getter/setter pair
CreateTensorTypeAndShapeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtTensorTypeAndShapeInfo>> out)>>: \brief Create an ::OrtTensorTypeAndShapeInfo object
getter/setter pair
CreateTensorWithDataAndDeleterAsOrtValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtAllocator> deleter, Pointer<Void> p_data, Size p_data_len, Pointer<Int64> shape, Size shape_len, UnsignedInt type, Pointer<Pointer<OrtValue>> out)>>: \brief Create an OrtValue for a Tensor that uses pre-existing memory.
getter/setter pair
CreateTensorWithDataAsOrtValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtMemoryInfo> info, Pointer<Void> p_data, Size p_data_len, Pointer<Int64> shape, Size shape_len, UnsignedInt type, Pointer<Pointer<OrtValue>> out)>>: \brief Create a tensor backed by a user supplied buffer
getter/setter pair
CreateThreadingOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtThreadingOptions>> out)>>: \brief Create an ::OrtThreadingOptions
getter/setter pair
CreateValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtValue>> in$, Size num_values, UnsignedInt value_type, Pointer<Pointer<OrtValue>> out)>>: \brief Create a map or sequence ::OrtValue
getter/setter pair
CustomOpDomain_Add ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtCustomOpDomain> custom_op_domain, Pointer<OrtCustomOp> op)>>: \brief Add a custom op to a custom op domain
getter/setter pair
DeviceEpIncompatibilityDetails_GetErrorCode ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtDeviceEpIncompatibilityDetails> details, Pointer<Int32> error_code)>>: \brief Get the execution provider error code from OrtDeviceEpIncompatibilityDetails.
getter/setter pair
DeviceEpIncompatibilityDetails_GetNotes ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtDeviceEpIncompatibilityDetails> details, Pointer<Pointer<Char>> notes)>>: \brief Get the notes from OrtDeviceEpIncompatibilityDetails.
getter/setter pair
DeviceEpIncompatibilityDetails_GetReasonsBitmask ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtDeviceEpIncompatibilityDetails> details, Pointer<Uint32> reasons_bitmask)>>: \brief Get the incompatibility reasons bitmask from OrtDeviceEpIncompatibilityDetails.
getter/setter pair
DisableCpuMemArena ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options)>>: \brief Disable the memory arena on CPU
getter/setter pair
DisableMemPattern ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options)>>: \brief Disable the memory pattern optimization
getter/setter pair
DisablePerSessionThreads ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options)>>: \brief Use global thread pool on a session
getter/setter pair
DisableProfiling ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options)>>: \brief Disable profiling for a session
getter/setter pair
DisableTelemetryEvents ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env)>>: \brief Disable Telemetry
getter/setter pair
EnableCpuMemArena ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options)>>: \brief Enable the memory arena on CPU
getter/setter pair
EnableMemPattern ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options)>>: \brief Enable the memory pattern optimization
getter/setter pair
EnableOrtCustomOps ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options)>>: \brief Enable custom operators
getter/setter pair
EnableProfiling ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> profile_file_prefix)>>: \brief Enable profiling for a session
getter/setter pair
EnableTelemetryEvents ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env)>>: \brief Enable Telemetry
getter/setter pair
EpAssignedNode_GetDomain ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpAssignedNode> ep_node, Pointer<Pointer<Char>> out)>>: \brief Get the domain of the node assigned to an execution provider.
getter/setter pair
EpAssignedNode_GetName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpAssignedNode> ep_node, Pointer<Pointer<Char>> out)>>: \brief Get the name of the node assigned to an execution provider.
getter/setter pair
EpAssignedNode_GetOperatorType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpAssignedNode> ep_node, Pointer<Pointer<Char>> out)>>: \brief Get the operator type of the node assigned to an execution provider.
getter/setter pair
EpAssignedSubgraph_GetEpName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpAssignedSubgraph> ep_subgraph, Pointer<Pointer<Char>> out)>>: \brief Get the name of the execution provider to which the subgraph was assigned.
getter/setter pair
EpAssignedSubgraph_GetNodes ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpAssignedSubgraph> ep_subgraph, Pointer<Pointer<Pointer<OrtEpAssignedNode>>> ep_nodes, Pointer<Size> num_ep_nodes)>>: \brief Get the nodes in a subgraph assigned to a specific execution provider.
getter/setter pair
EpDevice_Device ↔ Pointer<NativeFunction<Pointer<OrtHardwareDevice> Function(Pointer<OrtEpDevice> ep_device)>>: \brief Get the OrtHardwareDevice instance for the OrtEpDevice.
getter/setter pair
EpDevice_EpMetadata ↔ Pointer<NativeFunction<Pointer<OrtKeyValuePairs> Function(Pointer<OrtEpDevice> ep_device)>>: \brief Get the metadata for the OrtEpDevice.
getter/setter pair
EpDevice_EpName ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtEpDevice> ep_device)>>: \brief Get the execution provider name.
getter/setter pair
EpDevice_EpOptions ↔ Pointer<NativeFunction<Pointer<OrtKeyValuePairs> Function(Pointer<OrtEpDevice> ep_device)>>: \brief Get the execution provider options for the OrtEpDevice.
getter/setter pair
EpDevice_EpVendor ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtEpDevice> ep_device)>>: \brief Get the execution provider's vendor name.
getter/setter pair
EpDevice_MemoryInfo ↔ Pointer<NativeFunction<Pointer<OrtMemoryInfo> Function(Pointer<OrtEpDevice> ep_device, UnsignedInt memory_type)>>: \brief Get the OrtMemoryInfo for the device.
getter/setter pair
ExternalInitializerInfo_GetByteSize ↔ Pointer<NativeFunction<Size Function(Pointer<OrtExternalInitializerInfo> info)>>: \brief Get the size in bytes of the initializer's data within the file.
getter/setter pair
ExternalInitializerInfo_GetFileOffset ↔ Pointer<NativeFunction<Int64 Function(Pointer<OrtExternalInitializerInfo> info)>>: \brief Get the byte offset within the file where the initializer's data is stored.
getter/setter pair
ExternalInitializerInfo_GetFilePath ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtExternalInitializerInfo> info)>>: \brief Get the relative path to the file that stores the initializer's data.
getter/setter pair
FillSparseTensorBlockSparse ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<OrtMemoryInfo> data_mem_info, Pointer<Int64> values_shape, Size values_shape_len, Pointer<Void> values, Pointer<Int64> indices_shape_data, Size indices_shape_len, Pointer<Int32> indices_data)>>: This fills populates an empty tensor that was created using OrtApi::CreateSparseTensorAsOrtValue. This will allocate required memory and copy the supplied NNZ values and BlockSparse indices into that memory allocation. Memory allocation is performed using the allocator that was specified with OrtApi::CreateSparseTensorAsOrtValue.
getter/setter pair
FillSparseTensorCoo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<OrtMemoryInfo> data_mem_info, Pointer<Int64> values_shape, Size values_shape_len, Pointer<Void> values, Pointer<Int64> indices_data, Size indices_num)>>: This fills populates an empty tensor that was created using OrtApi::CreateSparseTensorAsOrtValue. This will allocate required memory and copy the supplied NNZ values and COO indices into that memory allocation. Memory allocation is performed using the allocator that was specified with OrtApi::CreateSparseTensorAsOrtValue.
getter/setter pair
FillSparseTensorCsr ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<OrtMemoryInfo> data_mem_info, Pointer<Int64> values_shape, Size values_shape_len, Pointer<Void> values, Pointer<Int64> inner_indices_data, Size inner_indices_num, Pointer<Int64> outer_indices_data, Size outer_indices_num)>>: This fills populates an empty tensor that was created using OrtApi::CreateSparseTensorAsOrtValue. This will allocate required memory and copy the supplied NNZ values and CSR indices into that memory allocation. Memory allocation is performed using the allocator that was specified with OrtApi::CreateSparseTensorAsOrtValue.
getter/setter pair
FillStringTensor ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Pointer<Char>> s, Size s_len)>>: \brief Set all strings at once in a string tensor
getter/setter pair
FillStringTensorElement ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Char> s, Size index)>>: \brief Set a single string in a string tensor
getter/setter pair
GetAllocatorWithDefaultOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtAllocator>> out)>>: \brief Get the default allocator
getter/setter pair
GetAvailableProviders ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<Pointer<Char>>> out_ptr, Pointer<Int> provider_length)>>: \brief Get the names of all available providers
getter/setter pair
GetBoundOutputNames ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtIoBinding> binding_ptr, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> buffer, Pointer<Pointer<Size>> lengths, Pointer<Size> count)>>: \brief Get the names of an ::OrtIoBinding's outputs
getter/setter pair
GetBoundOutputValues ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtIoBinding> binding_ptr, Pointer<OrtAllocator> allocator, Pointer<Pointer<Pointer<OrtValue>>> output, Pointer<Size> output_count)>>: \brief Get the output ::OrtValue objects from an ::OrtIoBinding
getter/setter pair
GetBuildInfoString ↔ Pointer<NativeFunction<Pointer<Char> Function()>>: \brief Returns a null terminated string of the build info including git info and cxx flags
getter/setter pair
GetCANNProviderOptionsAsString ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtCANNProviderOptions> cann_options, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> ptr)>>: \brief Get serialized CANN provider options string.
getter/setter pair
GetCompatibilityInfoFromModel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> model_path, Pointer<Char> ep_type, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> compatibility_info)>>: \brief Extract EP compatibility info from a precompiled model file.
getter/setter pair
GetCompatibilityInfoFromModelBytes ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Void> model_data, Size model_data_length, Pointer<Char> ep_type, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> compatibility_info)>>: \brief Extract EP compatibility info from precompiled model bytes in memory.
getter/setter pair
GetCompileApi ↔ Pointer<NativeFunction<Pointer<OrtCompileApi> Function()>>: \brief Get the Compile API instance.
getter/setter pair
GetCUDAProviderOptionsAsString ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtCUDAProviderOptionsV2> cuda_options, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> ptr)>>: Get serialized CUDA provider options string.
getter/setter pair
GetCUDAProviderOptionsByName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtCUDAProviderOptionsV2> cuda_options, Pointer<Char> key, Pointer<Pointer<Void>> ptr)>>: Get CUDA EP provider option where its data type is pointer. If the data type of the provider option can be represented by string please use GetCUDAProviderOptionsAsString.
getter/setter pair
GetCurrentGpuDeviceId ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Int> device_id)>>: \brief Get current GPU device ID
getter/setter pair
GetDenotationFromTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTypeInfo> type_info, Pointer<Pointer<Char>> denotation, Pointer<Size> len)>>: \brief Get denotation from type information
getter/setter pair
GetDimensions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorTypeAndShapeInfo> info, Pointer<Int64> dim_values, Size dim_values_length)>>: \brief Get dimensions in ::OrtTensorTypeAndShapeInfo
getter/setter pair
GetDimensionsCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorTypeAndShapeInfo> info, Pointer<Size> out)>>: \brief Get dimension count in ::OrtTensorTypeAndShapeInfo
getter/setter pair
GetDnnlProviderOptionsAsString ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtDnnlProviderOptions> dnnl_options, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> ptr)>>: Get serialized oneDNN provider options string.
getter/setter pair
GetEpApi ↔ Pointer<NativeFunction<Pointer<OrtEpApi> Function()>>: \brief Get the OrtEpApi instance for implementing an execution provider.
getter/setter pair
GetEpDevices ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Pointer<Pointer<OrtEpDevice>>> ep_devices, Pointer<Size> num_ep_devices)>>: \brief Get the list of available OrtEpDevice instances.
getter/setter pair
GetErrorCode ↔ Pointer<NativeFunction<UnsignedInt Function(Pointer<OrtStatus> status)>>: \brief Get OrtErrorCode from OrtStatus
getter/setter pair
GetErrorMessage ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtStatus> status)>>: \brief Get error string from OrtStatus
getter/setter pair
GetExecutionProviderApi ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> provider_name, Uint32 version, Pointer<Pointer<Void>> provider_api)>>: @} \name GetExecutionProviderApi @{ /** \brief Get a pointer to the requested version of the Execution Provider specific
getter/setter pair
GetHardwareDeviceEpIncompatibilityDetails ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Char> ep_name, Pointer<OrtHardwareDevice> hw, Pointer<Pointer<OrtDeviceEpIncompatibilityDetails>> details)>>: \brief Check for known incompatibility issues between hardware device and a specific execution provider.
getter/setter pair
GetHardwareDevices ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Pointer<OrtHardwareDevice>> devices, Size num_devices)>>: \brief Get the list of available hardware devices.
getter/setter pair
GetInteropApi ↔ Pointer<NativeFunction<Pointer<OrtInteropApi> Function()>>: \brief Get the EP Interop API instance.
getter/setter pair
GetKeyValue ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtKeyValuePairs> kvps, Pointer<Char> key)>>: \brief Get the value associated with a key in the OrtKeyValuePairs instance.
getter/setter pair
GetKeyValuePairs ↔ Pointer<NativeFunction<Void Function(Pointer<OrtKeyValuePairs> kvps, Pointer<Pointer<Pointer<Char>>> keys, Pointer<Pointer<Pointer<Char>>> values, Pointer<Size> num_entries)>>: \brief Get all the key-value pairs from the OrtKeyValuePairs instance.
getter/setter pair
GetMapKeyType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtMapTypeInfo> map_type_info, Pointer<UnsignedInt> out)>>: \brief Get key type from an ::OrtMapTypeInfo
getter/setter pair
GetMapValueType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtMapTypeInfo> map_type_info, Pointer<Pointer<OrtTypeInfo>> type_info)>>: \brief Get the value type from an ::OrtMapTypeInfo
getter/setter pair
GetModelCompatibilityForEpDevices ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtEpDevice>> ep_devices, Size num_ep_devices, Pointer<Char> compatibility_info, Pointer<UnsignedInt> out_status)>>: \brief Validate a compiled model's compatibility information for one or more EP devices.
getter/setter pair
GetModelEditorApi ↔ Pointer<NativeFunction<Pointer<OrtModelEditorApi> Function()>>: \brief Get the Model Editor API instance
getter/setter pair
GetNumHardwareDevices ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Size> num_devices)>>: \brief Get the number of available hardware devices.
getter/setter pair
GetOnnxTypeFromTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTypeInfo> type_info, Pointer<UnsignedInt> out)>>: \brief Get ::ONNXType from ::OrtTypeInfo
getter/setter pair
GetOpaqueValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Char> domain_name, Pointer<Char> type_name, Pointer<OrtValue> in$, Pointer<Void> data_container, Size data_container_size)>>: \brief Get internal data from an opaque (custom user defined type) ::OrtValue
getter/setter pair
GetOptionalContainedTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtOptionalTypeInfo> optional_type_info, Pointer<Pointer<OrtTypeInfo>> out)>>: \brief Get OrtTypeInfo for the allowed contained type from an ::OrtOptionalTypeInfo.
getter/setter pair
GetResizedStringTensorElementBuffer ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Size index, Size length_in_bytes, Pointer<Pointer<Char>> buffer)>>: \brief Set a single string in a string tensor Do not zero terminate the string data.
getter/setter pair
GetROCMProviderOptionsAsString ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtROCMProviderOptions> rocm_options, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> ptr)>>: Get serialized ROCm provider options string.
getter/setter pair
GetRunConfigEntry ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtRunOptions> options, Pointer<Char> config_key)>>: \brief Get a run configuration entry.
getter/setter pair
GetSequenceElementType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSequenceTypeInfo> sequence_type_info, Pointer<Pointer<OrtTypeInfo>> type_info)>>: \brief Get element type from an ::OrtSequenceTypeInfo
getter/setter pair
GetSessionConfigEntry ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> config_key, Pointer<Char> config_value, Pointer<Size> size)>>: \brief Get a session configuration value.
getter/setter pair
GetSessionOptionsConfigEntries ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Pointer<OrtKeyValuePairs>> out)>>: \brief Get Session configuration entries.
getter/setter pair
GetSharedAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<OrtMemoryInfo> mem_info, Pointer<Pointer<OrtAllocator>> allocator)>>: \brief Get a shared allocator from the OrtEnv.
getter/setter pair
GetSparseTensorFormat ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<UnsignedInt> out)>>: \brief Returns sparse tensor format enum iff a given ort value contains an instance of sparse tensor.
getter/setter pair
GetSparseTensorIndices ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, UnsignedInt indices_format, Pointer<Size> num_indices, Pointer<Pointer<Void>> indices)>>: \brief Returns indices data for the type of the indices specified by indices_format
getter/setter pair
GetSparseTensorIndicesTypeShape ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, UnsignedInt indices_format, Pointer<Pointer<OrtTensorTypeAndShapeInfo>> out)>>: \brief Returns data type, shape for the type of indices specified by indices_format.
getter/setter pair
GetSparseTensorValues ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<Pointer<Void>> out)>>: \brief Returns numeric data for sparse tensor values (nnz). For string values use GetStringTensor*().
getter/setter pair
GetSparseTensorValuesTypeAndShape ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<Pointer<OrtTensorTypeAndShapeInfo>> out)>>: \brief Returns data type and shape of sparse tensor values (nnz) iff ::OrtValue contains a SparseTensor.
getter/setter pair
GetStringTensorContent ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Void> s, Size s_len, Pointer<Size> offsets, Size offsets_len)>>: \brief Get all strings from a string tensor
getter/setter pair
GetStringTensorDataLength ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Size> len)>>: \brief Get total byte length for all strings in a string tensor
getter/setter pair
GetStringTensorElement ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Size s_len, Size index, Pointer<Void> s)>>: \brief Get a single string from a string tensor
getter/setter pair
GetStringTensorElementLength ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Size index, Pointer<Size> out)>>: \brief Get the length of a single string in a string tensor
getter/setter pair
GetSymbolicDimensions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorTypeAndShapeInfo> info, Pointer<Pointer<Char>> dim_params, Size dim_params_length)>>: \brief Get symbolic dimension names in ::OrtTensorTypeAndShapeInfo
getter/setter pair
GetTensorData ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Pointer<Void>> out)>>: \brief Get a const pointer to the raw data inside a tensor
getter/setter pair
GetTensorElementType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorTypeAndShapeInfo> info, Pointer<UnsignedInt> out)>>: \brief Get element type in ::OrtTensorTypeAndShapeInfo
getter/setter pair
GetTensorElementTypeAndShapeDataReference ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<UnsignedInt> elem_type, Pointer<Pointer<Int64>> shape_data, Pointer<Size> shape_data_count)>>: \brief Get the element data type and shape for an OrtValue that represents a Tensor (scalar, dense, or sparse).
getter/setter pair
GetTensorMemoryInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Pointer<OrtMemoryInfo>> mem_info)>>: @} \name GetTensorMemoryInfo @{ /** \brief Returns a pointer to the ::OrtMemoryInfo of a Tensor
getter/setter pair
GetTensorMutableData ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Pointer<Void>> out)>>: \brief Get a pointer to the raw data inside a tensor
getter/setter pair
GetTensorRTProviderOptionsAsString ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorRTProviderOptionsV2> tensorrt_options, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> ptr)>>: \brief Get serialized TensorRT provider options string.
getter/setter pair
GetTensorRTProviderOptionsByName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorRTProviderOptionsV2> tensorrt_options, Pointer<Char> key, Pointer<Pointer<Void>> ptr)>>: Get TensorRT EP provider option where its data type is pointer. If the data type of the provider option can be represented by string please use GetTensorRTProviderOptionsAsString.
getter/setter pair
GetTensorShapeElementCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorTypeAndShapeInfo> info, Pointer<Size> out)>>: \brief Get total number of elements in a tensor shape from an ::OrtTensorTypeAndShapeInfo
getter/setter pair
GetTensorSizeInBytes ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<Size> size)>>: \brief Compute total size in bytes of the tensor data contained in an OrtValue.
getter/setter pair
GetTensorTypeAndShape ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Pointer<OrtTensorTypeAndShapeInfo>> out)>>: \brief Get type and shape information from a tensor ::OrtValue
getter/setter pair
GetTrainingApi ↔ Pointer<NativeFunction<Pointer<OrtTrainingApi> Function(Uint32 version)>>: \name Ort Training @{ /** \brief Gets the Training C Api struct *
getter/setter pair
GetTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Pointer<OrtTypeInfo>> out)>>: \brief Get type information of an OrtValue
getter/setter pair
GetValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Int index, Pointer<OrtAllocator> allocator, Pointer<Pointer<OrtValue>> out)>>: \brief Get non tensor data from an ::OrtValue
getter/setter pair
GetValueCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Size> out)>>: \brief Get non tensor value count from an ::OrtValue
getter/setter pair
GetValueInfoName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Pointer<Char>> name)>>: \brief Get the value name from an OrtValueInfo instance. \paramin value_info The OrtValueInfo instance. \paramout name The name of the OrtValueInfo \snippet{doc} snippets.dox OrtStatus Return Value \since Version 1.22.
getter/setter pair
GetValueInfoTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Pointer<OrtTypeInfo>> type_info)>>: \brief Get the type information from an OrtValueInfo instance. \paramin value_info The OrtValueInfo instance. \paramout type_info The type info of the OrtValueInfo \snippet{doc} snippets.dox OrtStatus Return Value \since Version 1.22.
getter/setter pair
GetValueType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<UnsignedInt> out)>>: \brief Get ONNXType of an ::OrtValue
getter/setter pair
Graph_GetGraphView ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> src_graph, Pointer<Pointer<OrtNode>> nodes, Size num_nodes, Pointer<Pointer<OrtGraph>> dst_graph)>>: \brief Returns an OrtGraph that contains a subset of nodes in the source OrtGraph.
getter/setter pair
Graph_GetInitializers ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Pointer<OrtValueInfo>> initializers, Size num_initializers)>>: \brief Returns the graph's initializers as OrtValueInfo instances.
getter/setter pair
Graph_GetInputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Pointer<OrtValueInfo>> inputs, Size num_inputs)>>: \brief Returns the graph's inputs as OrtValueInfo instances.
getter/setter pair
Graph_GetModelMetadata ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Pointer<OrtModelMetadata>> out)>>: \brief Get ::OrtModelMetadata from an ::OrtGraph
getter/setter pair
Graph_GetModelPath ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Pointer<Char>> model_path)>>: \brief Get the filepath to the model from which an OrtGraph is constructed.
getter/setter pair
Graph_GetName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Pointer<Char>> graph_name)>>: \brief Returns a graph's name.
getter/setter pair
Graph_GetNodes ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Pointer<OrtNode>> nodes, Size num_nodes)>>: \brief Returns the graph's nodes as OrtNode instances.
getter/setter pair
Graph_GetNumInitializers ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Size> num_initializers)>>: \brief Returns the number of graph initializers.
getter/setter pair
Graph_GetNumInputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Size> num_inputs)>>: \brief Returns the number of graph inputs.
getter/setter pair
Graph_GetNumNodes ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Size> num_nodes)>>: \brief Returns the number of graph nodes.
getter/setter pair
Graph_GetNumOperatorSets ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Size> num_operator_sets)>>: \brief Returns the number of operator sets that the graph's model uses.
getter/setter pair
Graph_GetNumOutputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Size> num_outputs)>>: \brief Returns the number of graph outputs.
getter/setter pair
Graph_GetOnnxIRVersion ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Int64> onnx_ir_version)>>: \brief Returns the ONNX IR version.
getter/setter pair
Graph_GetOperatorSets ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Pointer<Char>> domains, Pointer<Int64> opset_versions, Size num_operator_sets)>>: \brief Returns the operator sets that the graph's model uses.
getter/setter pair
Graph_GetOutputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Pointer<OrtValueInfo>> outputs, Size num_outputs)>>: \brief Returns the graph's outputs as OrtValueInfo instances.
getter/setter pair
Graph_GetParentNode ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtGraph> graph, Pointer<Pointer<OrtNode>> node)>>: \brief Get the parent node for the given graph, if any exists.
getter/setter pair
HardwareDevice_DeviceId ↔ Pointer<NativeFunction<Uint32 Function(Pointer<OrtHardwareDevice> device)>>: \brief Get the hardware device's unique identifier.
getter/setter pair
HardwareDevice_Metadata ↔ Pointer<NativeFunction<Pointer<OrtKeyValuePairs> Function(Pointer<OrtHardwareDevice> device)>>: \brief Get hardware device metadata.
getter/setter pair
HardwareDevice_Type ↔ Pointer<NativeFunction<UnsignedInt Function(Pointer<OrtHardwareDevice> device)>>: \brief Get the hardware device type.
getter/setter pair
HardwareDevice_Vendor ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtHardwareDevice> device)>>: \brief Get the hardware device's vendor name.
getter/setter pair
HardwareDevice_VendorId ↔ Pointer<NativeFunction<Uint32 Function(Pointer<OrtHardwareDevice> device)>>: \brief Get the hardware device's vendor identifier.
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
HasSessionConfigEntry ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> config_key, Pointer<Int> out)>>: \brief Checks if the given session configuration entry exists.
getter/setter pair
HasValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Int> out)>>: \brief Sets out to 1 iff an optional type OrtValue has an element, 0 otherwise (OrtValue is None) Use this API to find if the optional type OrtValue is None or not. If the optional type OrtValue is not None, use the OrtValue just like any other OrtValue. For example, if you get an OrtValue that corresponds to Optional(tensor) and if HasValue() returns true, use it as tensor and so on.
getter/setter pair
InvokeOp ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Pointer<OrtOp> ort_op, Pointer<Pointer<OrtValue>> input_values, Int input_count, Pointer<Pointer<OrtValue>> output_values, Int output_count)>>: \brief: Invoke the operator created by OrtApi::CreateOp The inputs must follow the order as specified in onnx specification
getter/setter pair
IsSparseTensor ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Int> out)>>: \brief Sets *out to 1 iff an ::OrtValue is a SparseTensor, and 0 otherwise
getter/setter pair
IsTensor ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Int> out)>>: \brief Return if an ::OrtValue is a tensor type
getter/setter pair
KernelContext_GetAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Pointer<OrtMemoryInfo> mem_info, Pointer<Pointer<OrtAllocator>> out)>>: \brief Get Allocator from KernelContext for a specific memoryInfo. Please use C API ReleaseAllocator to release out object
getter/setter pair
KernelContext_GetGPUComputeStream ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Pointer<Pointer<Void>> out)>>: \brief Used for custom operators, gets the GPU compute stream to use to launch the custom a GPU kernel \see ::OrtCustomOp \paramin context OrtKernelContext instance \paramout out Returns pointer to a GPU compute stream that can be used to launch the custom GPU kernel. If retrieving the GPU compute stream is not relevant (GPU not enabled in the build, kernel partitioned to some other EP), then a nullptr is returned as the output param. Do not free or mutate the returned pointer as it refers to internal data owned by the underlying session. Only use it for custom kernel launching.
getter/setter pair
KernelContext_GetInput ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Size index, Pointer<Pointer<OrtValue>> out)>>: \brief Used for custom operators, get an input of a kernel
getter/setter pair
KernelContext_GetInputCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Pointer<Size> out)>>: \brief Used for custom operators, get the input count of a kernel
getter/setter pair
KernelContext_GetLogger ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Pointer<Pointer<OrtLogger>> logger)>>: \brief Get the runtime logger from ::OrtKernelContext.
getter/setter pair
KernelContext_GetOutput ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Size index, Pointer<Int64> dim_values, Size dim_count, Pointer<Pointer<OrtValue>> out)>>: \brief Used for custom operators, get an output of a kernel
getter/setter pair
KernelContext_GetOutputCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Pointer<Size> out)>>: \brief Used for custom operators, get the output count of a kernel
getter/setter pair
KernelContext_GetResource ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Int resource_version, Int resource_id, Pointer<Pointer<Void>> resource)>>: Get a EP resource. E.g. a cuda stream or a cublas handle
getter/setter pair
KernelContext_GetScratchBuffer ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Pointer<OrtMemoryInfo> mem_info, Size count_or_bytes, Pointer<Pointer<Void>> out)>>: \brief Get scratch buffer from the corresponding allocator under the specific OrtMemoryInfo object. NOTE: callers are responsible to release this scratch buffer from the corresponding allocator \paramin context OrtKernelContext instance \paramin mem_info OrtMemoryInfo instance \paramin count_or_bytes How many bytes is this scratch buffer \paramout out A pointer to the scratch buffer
getter/setter pair
KernelContext_ParallelFor ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelContext> context, Pointer<NativeFunction<Void Function(Pointer<Void>, Size)>> fn, Size total, Size num_batch, Pointer<Void> usr_data)>>: Run fn in parallel
getter/setter pair
KernelInfo_GetConfigEntries ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Pointer<OrtKeyValuePairs>> out)>>: \brief Get all config entries from ::OrtKernelInfo.
getter/setter pair
KernelInfo_GetInputCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Size> out)>>: \brief Get the number of inputs from ::OrtKernelInfo.
getter/setter pair
KernelInfo_GetInputName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Size index, Pointer<Char> out, Pointer<Size> size)>>: \brief Get the name of a ::OrtKernelInfo's input.
getter/setter pair
KernelInfo_GetInputTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Size index, Pointer<Pointer<OrtTypeInfo>> type_info)>>: \brief Get the type information for a ::OrtKernelInfo's input.
getter/setter pair
KernelInfo_GetLogger ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Pointer<OrtLogger>> logger)>>: \brief Get the session logger from ::OrtKernelInfo.
getter/setter pair
KernelInfo_GetNodeName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> out, Pointer<Size> size)>>: \brief Get the graph node name from ::OrtKernelInfo.
getter/setter pair
KernelInfo_GetOperatorDomain ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> out, Pointer<Size> size)>>: \brief Get the graph node's operator domain from ::OrtKernelInfo.
getter/setter pair
KernelInfo_GetOperatorSinceVersion ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Int> since_version)>>: \brief Get the opset version in which the given node's operator type was first defined from ::OrtKernelInfo.
getter/setter pair
KernelInfo_GetOperatorType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> out, Pointer<Size> size)>>: \brief Get the graph node's operator type from ::OrtKernelInfo.
getter/setter pair
KernelInfo_GetOutputCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Size> out)>>: \brief Get the number of outputs from ::OrtKernelInfo.
getter/setter pair
KernelInfo_GetOutputName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Size index, Pointer<Char> out, Pointer<Size> size)>>: \brief Get the name of a ::OrtKernelInfo's output.
getter/setter pair
KernelInfo_GetOutputTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Size index, Pointer<Pointer<OrtTypeInfo>> type_info)>>: \brief Get the type information for a ::OrtKernelInfo's output.
getter/setter pair
KernelInfoGetAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Int mem_type, Pointer<Pointer<OrtAllocator>> out)>>: \brief Get allocator from KernelInfo for a specific memory type. Please use C API ReleaseAllocator to release out object
getter/setter pair
KernelInfoGetAttribute_float ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> name, Pointer<Float> out)>>: \brief Get a float stored as an attribute in the graph node
getter/setter pair
KernelInfoGetAttribute_int64 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> name, Pointer<Int64> out)>>: \brief Fetch a 64-bit int stored as an attribute in the graph node
getter/setter pair
KernelInfoGetAttribute_string ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> name, Pointer<Char> out, Pointer<Size> size)>>: \brief Fetch a string stored as an attribute in the graph node
getter/setter pair
KernelInfoGetAttribute_tensor ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> name, Pointer<OrtAllocator> allocator, Pointer<Pointer<OrtValue>> out)>>: \brief Get a ::OrtValue tensor stored as an attribute in the graph node.
getter/setter pair
KernelInfoGetAttributeArray_float ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> name, Pointer<Float> out, Pointer<Size> size)>>: \brief Fetch an array of int64_t values stored as an attribute in the graph node
getter/setter pair
KernelInfoGetAttributeArray_int64 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Char> name, Pointer<Int64> out, Pointer<Size> size)>>: \brief Fetch an array of int64_t values stored as an attribute in the graph node
getter/setter pair
KernelInfoGetConstantInput_tensor ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Size index, Pointer<Int> is_constant, Pointer<Pointer<OrtValue>> out)>>: \brief Get a ::OrtValue tensor stored as a constant initializer in the graph node.
getter/setter pair
Logger_GetLoggingSeverityLevel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtLogger> logger, Pointer<UnsignedInt> out)>>: \brief Get the logging severity level of the ::OrtLogger.
getter/setter pair
Logger_LogMessage ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtLogger> logger, UnsignedInt log_severity_level, Pointer<Char> message, Pointer<Char> file_path, Int line_number, Pointer<Char> func_name)>>: \brief Logs a message at the given severity level using the provided ::OrtLogger.
getter/setter pair
MemoryInfoGetDeviceMemType ↔ Pointer<NativeFunction<UnsignedInt Function(Pointer<OrtMemoryInfo> ptr)>>: \brief Get the device memory type from ::OrtMemoryInfo
getter/setter pair
MemoryInfoGetDeviceType ↔ Pointer<NativeFunction<Void Function(Pointer<OrtMemoryInfo> ptr, Pointer<UnsignedInt> out)>>: \brief Get OrtDevice type from MemoryInfo
getter/setter pair
MemoryInfoGetId ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtMemoryInfo> ptr, Pointer<Int> out)>>: \brief Get the device id from ::OrtMemoryInfo
getter/setter pair
MemoryInfoGetMemType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtMemoryInfo> ptr, Pointer<Int> out)>>: \brief Get the ::OrtMemType from ::OrtMemoryInfo
getter/setter pair
MemoryInfoGetName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtMemoryInfo> ptr, Pointer<Pointer<Char>> out)>>: \brief Get name from ::OrtMemoryInfo
getter/setter pair
MemoryInfoGetType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtMemoryInfo> ptr, Pointer<Int> out)>>: \brief Get the ::OrtAllocatorType from ::OrtMemoryInfo
getter/setter pair
MemoryInfoGetVendorId ↔ Pointer<NativeFunction<Uint32 Function(Pointer<OrtMemoryInfo> ptr)>>: \brief Get the vendor id from ::OrtMemoryInfo
getter/setter pair
ModelMetadataGetCustomMetadataMapKeys ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtModelMetadata> model_metadata, Pointer<OrtAllocator> allocator, Pointer<Pointer<Pointer<Char>>> keys, Pointer<Int64> num_keys)>>: \paramin model_metadata \paramin allocator \paramout keys Array of null terminated strings (array count = num_keys) allocated using allocator. The strings and the pointer array must be freed using allocator keys will be set to nullptr if the custom metadata map is empty. \paramout num_keys Set to the number of elements in the keys array
getter/setter pair
ModelMetadataGetDescription ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtModelMetadata> model_metadata, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> value)>>: \brief Get description from an ::OrtModelMetadata
getter/setter pair
ModelMetadataGetDomain ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtModelMetadata> model_metadata, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> value)>>: \brief Get domain from an ::OrtModelMetadata
getter/setter pair
ModelMetadataGetGraphDescription ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtModelMetadata> model_metadata, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> value)>>: Use this to obtain the description of the graph present in the model (doc_string field of the GraphProto message within the ModelProto message). If it doesn't exist, an empty string will be returned.
getter/setter pair
ModelMetadataGetGraphName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtModelMetadata> model_metadata, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> value)>>: \brief Get graph name from an ::OrtModelMetadata
getter/setter pair
ModelMetadataGetProducerName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtModelMetadata> model_metadata, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> value)>>: \brief Get producer name from an ::OrtModelMetadata
getter/setter pair
ModelMetadataGetVersion ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtModelMetadata> model_metadata, Pointer<Int64> value)>>: \brief Get version number from an ::OrtModelMetadata
getter/setter pair
ModelMetadataLookupCustomMetadataMap ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtModelMetadata> model_metadata, Pointer<OrtAllocator> allocator, Pointer<Char> key, Pointer<Pointer<Char>> value)>>: \brief Return data for a key in the custom metadata map in an ::OrtModelMetadata
getter/setter pair
Node_GetAttributeByName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Char> attribute_name, Pointer<Pointer<OrtOpAttr>> attribute)>>: \brief Gets the OrtNode's attribute as OrtOpAttr by name.
getter/setter pair
Node_GetAttributes ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<OrtOpAttr>> attributes, Size num_attributes)>>: \brief Returns a node's attributes as OrtOpAttr instances.
getter/setter pair
Node_GetDomain ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<Char>> domain_name)>>: \brief Returns a node's domain name.
getter/setter pair
Node_GetEpName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<Char>> out)>>: \brief Returns the execution provider name that this node is assigned to run on. Returns NULL if the node has not been assigned to any execution provider yet. For plugin execution providers, the name is the one returned by OrtEp::GetName.
getter/setter pair
Node_GetGraph ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<OrtGraph>> graph)>>: \brief Get the node's parent OrtGraph instance.
getter/setter pair
Node_GetId ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Size> node_id)>>: \brief Returns a node's identifier.
getter/setter pair
Node_GetImplicitInputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<OrtValueInfo>> implicit_inputs, Size num_implicit_inputs)>>: \brief Get the implicit inputs, as OrtValueInfo instances, that are used within the given node's subgraphs.
getter/setter pair
Node_GetInputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<OrtValueInfo>> inputs, Size num_inputs)>>: \brief Returns the node's inputs as OrtValueInfo instances.
getter/setter pair
Node_GetName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<Char>> node_name)>>: \brief Returns a node's name. Can be an empty string.
getter/setter pair
Node_GetNumAttributes ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Size> num_attributes)>>: \brief Returns the number of node attributes.
getter/setter pair
Node_GetNumImplicitInputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Size> num_implicit_inputs)>>: \brief Returns the number of node implicit inputs.
getter/setter pair
Node_GetNumInputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Size> num_inputs)>>: \brief Returns the number of node inputs.
getter/setter pair
Node_GetNumOutputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Size> num_outputs)>>: \brief Returns the number of node outputs.
getter/setter pair
Node_GetNumSubgraphs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Size> num_subgraphs)>>: \brief Returns the number of subgraphs contained by the given node.
getter/setter pair
Node_GetOperatorType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<Char>> operator_type)>>: \brief Returns a node's operator type (e.g., "Conv").
getter/setter pair
Node_GetOutputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<OrtValueInfo>> outputs, Size num_outputs)>>: \brief Returns the node's outputs as OrtValueInfo instances.
getter/setter pair
Node_GetSinceVersion ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Int> since_version)>>: \brief Get the opset version in which the given node's operator type was first defined.
getter/setter pair
Node_GetSubgraphs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtNode> node, Pointer<Pointer<OrtGraph>> subgraphs, Size num_subgraphs, Pointer<Pointer<Char>> attribute_names)>>: \brief Get the subgraphs, as OrtGraph instances, contained by the given node.
getter/setter pair
OpAttr_GetName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtOpAttr> attribute, Pointer<Pointer<Char>> name)>>: \brief Get the attribute name from an OrtOpAttr.
getter/setter pair
OpAttr_GetTensorAttributeAsOrtValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtOpAttr> attribute, Pointer<Pointer<OrtValue>> attr_tensor)>>: \brief Get the OrtNode's 'TENSOR' attribute as an OrtValue.
getter/setter pair
OpAttr_GetType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtOpAttr> attribute, Pointer<UnsignedInt> type)>>: \brief Get the attribute type as OrtOpAttrType from an OrtOpAttr.
getter/setter pair
ReadOpAttr ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtOpAttr> op_attr, UnsignedInt type, Pointer<Void> data, Size len, Pointer<Size> out)>>: Read contents of an attribute to data
getter/setter pair
RegisterAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<OrtAllocator> allocator)>>: \brief Register a custom allocator
getter/setter pair
RegisterCustomOpsLibrary ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> library_path, Pointer<Pointer<Void>> library_handle)>>: \deprecated Use OrtApi::RegisterCustomOpsLibrary_V2.
getter/setter pair
RegisterCustomOpsLibrary_V2 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> library_name)>>: \brief Register custom ops from a shared library.
getter/setter pair
RegisterCustomOpsUsingFunction ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> registration_func_name)>>: \brief Register custom ops by calling a RegisterCustomOpsFn function.
getter/setter pair
RegisterExecutionProviderLibrary ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Char> registration_name, Pointer<Char> path)>>: \brief Register an execution provider library with ORT.
getter/setter pair
ReleaseAllocator ↔ Pointer<NativeFunction<Void Function(Pointer<OrtAllocator> input)>>: \brief Release an ::OrtAllocator obtained from OrtApi::CreateAllocator
getter/setter pair
ReleaseArenaCfg ↔ Pointer<NativeFunction<Void Function(Pointer<OrtArenaCfg> input)>>: getter/setter pair
ReleaseAvailableProviders ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<Char>> ptr, Int providers_length)>>: \brief Release data from OrtApi::GetAvailableProviders. This API will never fail so you can rely on it in a noexcept code.
getter/setter pair
ReleaseCANNProviderOptions ↔ Pointer<NativeFunction<Void Function(Pointer<OrtCANNProviderOptions> input)>>: \brief Release an OrtCANNProviderOptions
getter/setter pair
ReleaseCUDAProviderOptions ↔ Pointer<NativeFunction<Void Function(Pointer<OrtCUDAProviderOptionsV2> input)>>: \brief Release an ::OrtCUDAProviderOptionsV2
getter/setter pair
ReleaseCustomOpDomain ↔ Pointer<NativeFunction<Void Function(Pointer<OrtCustomOpDomain> input)>>: @} \name OrtCustomOpDomain @{
getter/setter pair
ReleaseDeviceEpIncompatibilityDetails ↔ Pointer<NativeFunction<Void Function(Pointer<OrtDeviceEpIncompatibilityDetails> input)>>: \brief Release an OrtDeviceEpIncompatibilityDetails instance.
getter/setter pair
ReleaseDnnlProviderOptions ↔ Pointer<NativeFunction<Void Function(Pointer<OrtDnnlProviderOptions> input)>>: \brief Release an ::OrtDnnlProviderOptions
getter/setter pair
ReleaseEnv ↔ Pointer<NativeFunction<Void Function(Pointer<OrtEnv> input)>>: @} \name OrtEnv @{
getter/setter pair
ReleaseExternalInitializerInfo ↔ Pointer<NativeFunction<Void Function(Pointer<OrtExternalInitializerInfo> input)>>: \brief Release an OrtExternalInitializerInfo instance.
getter/setter pair
ReleaseGraph ↔ Pointer<NativeFunction<Void Function(Pointer<OrtGraph> input)>>: \brief Release an OrtGraph. \snippet{doc} snippets.dox OrtStatus Return Value \since Version 1.22.
getter/setter pair
ReleaseIoBinding ↔ Pointer<NativeFunction<Void Function(Pointer<OrtIoBinding> input)>>: \brief Release an ::OrtIoBinding obtained from OrtApi::CreateIoBinding
getter/setter pair
ReleaseKernelInfo ↔ Pointer<NativeFunction<Void Function(Pointer<OrtKernelInfo> input)>>: \brief: Release kernel info
getter/setter pair
ReleaseKeyValuePairs ↔ Pointer<NativeFunction<Void Function(Pointer<OrtKeyValuePairs> input)>>: \brief Release an OrtKeyValuePairs instance.
getter/setter pair
ReleaseLoraAdapter ↔ Pointer<NativeFunction<Void Function(Pointer<OrtLoraAdapter> input)>>: \brief Release an ::OrtLoraAdapter obtained from OrtApi::CreateLoraAdapter
getter/setter pair
ReleaseMapTypeInfo ↔ Pointer<NativeFunction<Void Function(Pointer<OrtMapTypeInfo> input)>>: @} \name OrtMapTypeInfo @{
getter/setter pair
ReleaseMemoryInfo ↔ Pointer<NativeFunction<Void Function(Pointer<OrtMemoryInfo> input)>>: @} \name OrtMemoryInfo @{
getter/setter pair
ReleaseModel ↔ Pointer<NativeFunction<Void Function(Pointer<OrtModel> input)>>: \brief Release an OrtModel. \snippet{doc} snippets.dox OrtStatus Return Value \since Version 1.22.
getter/setter pair
ReleaseModelMetadata ↔ Pointer<NativeFunction<Void Function(Pointer<OrtModelMetadata> input)>>: getter/setter pair
ReleaseNode ↔ Pointer<NativeFunction<Void Function(Pointer<OrtNode> input)>>: \brief Release an OrtNode if it was not added to an OrtGraph. \since Version 1.22.
getter/setter pair
ReleaseOp ↔ Pointer<NativeFunction<Void Function(Pointer<OrtOp> input)>>: \brief: Release an onnxruntime operator
getter/setter pair
ReleaseOpAttr ↔ Pointer<NativeFunction<Void Function(Pointer<OrtOpAttr> input)>>: \brief: Release op attribute
getter/setter pair
ReleasePrepackedWeightsContainer ↔ Pointer<NativeFunction<Void Function(Pointer<OrtPrepackedWeightsContainer> input)>>: \brief Release OrtPrepackedWeightsContainer instance
getter/setter pair
ReleaseROCMProviderOptions ↔ Pointer<NativeFunction<Void Function(Pointer<OrtROCMProviderOptions> input)>>: \brief Release an ::OrtROCMProviderOptions
getter/setter pair
ReleaseRunOptions ↔ Pointer<NativeFunction<Void Function(Pointer<OrtRunOptions> input)>>: @} \name OrtRunOptions @{
getter/setter pair
ReleaseSequenceTypeInfo ↔ Pointer<NativeFunction<Void Function(Pointer<OrtSequenceTypeInfo> input)>>: @} \name OrtSequenceTypeInfo @{
getter/setter pair
ReleaseSession ↔ Pointer<NativeFunction<Void Function(Pointer<OrtSession> input)>>: Don't call ReleaseSession from Dllmain (because session owns a thread pool)
getter/setter pair
ReleaseSessionOptions ↔ Pointer<NativeFunction<Void Function(Pointer<OrtSessionOptions> input)>>: @} \name OrtSessionOptions @{
getter/setter pair
ReleaseSharedAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<OrtEpDevice> ep_device, UnsignedInt mem_type)>>: \brief Release a shared allocator from the OrtEnv for the OrtEpDevice and memory type.
getter/setter pair
ReleaseStatus ↔ Pointer<NativeFunction<Void Function(Pointer<OrtStatus> input)>>: @} \name OrtStatus @{
getter/setter pair
ReleaseSyncStream ↔ Pointer<NativeFunction<Void Function(Pointer<OrtSyncStream> input)>>: getter/setter pair
ReleaseTensorRTProviderOptions ↔ Pointer<NativeFunction<Void Function(Pointer<OrtTensorRTProviderOptionsV2> input)>>: \brief Release an ::OrtTensorRTProviderOptionsV2
getter/setter pair
ReleaseTensorTypeAndShapeInfo ↔ Pointer<NativeFunction<Void Function(Pointer<OrtTensorTypeAndShapeInfo> input)>>: @} \name OrtTensorTypeAndShapeInfo @{
getter/setter pair
ReleaseThreadingOptions ↔ Pointer<NativeFunction<Void Function(Pointer<OrtThreadingOptions> input)>>: getter/setter pair
ReleaseTypeInfo ↔ Pointer<NativeFunction<Void Function(Pointer<OrtTypeInfo> input)>>: @} \name OrtTypeInfo @{
getter/setter pair
ReleaseValue ↔ Pointer<NativeFunction<Void Function(Pointer<OrtValue> input)>>: @} \name OrtValue @{
getter/setter pair
ReleaseValueInfo ↔ Pointer<NativeFunction<Void Function(Pointer<OrtValueInfo> input)>>: \brief Release an OrtValueInfo instance if it was not added to an OrtGraph. \since Version 1.22.
getter/setter pair
RemoveKeyValuePair ↔ Pointer<NativeFunction<Void Function(Pointer<OrtKeyValuePairs> kvps, Pointer<Char> key)>>: \brief Remove a key-value pair from the OrtKeyValuePairs instance.
getter/setter pair
Run ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<OrtRunOptions> run_options, Pointer<Pointer<Char>> input_names, Pointer<Pointer<OrtValue>> inputs, Size input_len, Pointer<Pointer<Char>> output_names, Size output_names_len, Pointer<Pointer<OrtValue>> outputs)>>: \brief Run the model in an ::OrtSession
getter/setter pair
RunAsync ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<OrtRunOptions> run_options, Pointer<Pointer<Char>> input_names, Pointer<Pointer<OrtValue>> input, Size input_len, Pointer<Pointer<Char>> output_names, Size output_names_len, Pointer<Pointer<OrtValue>> output, RunAsyncCallbackFn run_async_callback, Pointer<Void> user_data)>>: \brief Run the model asynchronously in a thread owned by intra op thread pool
getter/setter pair
RunOptionsAddActiveLoraAdapter ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options, Pointer<OrtLoraAdapter> adapter)>>: \brief Add the Lora Adapter to the list of active adapters.
getter/setter pair
RunOptionsGetRunLogSeverityLevel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options, Pointer<Int> log_severity_level)>>: \brief Get per-run log severity level
getter/setter pair
RunOptionsGetRunLogVerbosityLevel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options, Pointer<Int> log_verbosity_level)>>: \brief Get per-run log verbosity level
getter/setter pair
RunOptionsGetRunTag ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options, Pointer<Pointer<Char>> run_tag)>>: \brief Get per-run tag
getter/setter pair
RunOptionsSetRunLogSeverityLevel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options, Int log_severity_level)>>: \brief Set per-run log severity level
getter/setter pair
RunOptionsSetRunLogVerbosityLevel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options, Int log_verbosity_level)>>: \brief Set per-run log verbosity level
getter/setter pair
RunOptionsSetRunTag ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options, Pointer<Char> run_tag)>>: \brief Set per-run tag
getter/setter pair
RunOptionsSetSyncStream ↔ Pointer<NativeFunction<Void Function(Pointer<OrtRunOptions> options, Pointer<OrtSyncStream> sync_stream)>>: \brief Sets OrtSyncStream for the run options
getter/setter pair
RunOptionsSetTerminate ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options)>>: \brief Set terminate flag
getter/setter pair
RunOptionsUnsetTerminate ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtRunOptions> options)>>: \brief Clears the terminate flag
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
RunWithBinding ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<OrtRunOptions> run_options, Pointer<OrtIoBinding> binding_ptr)>>: \brief Run a model using Io Bindings for the inputs & outputs
getter/setter pair
Session_GetEpGraphAssignmentInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Pointer<Pointer<OrtEpAssignedSubgraph>>> ep_subgraphs, Pointer<Size> num_ep_subgraphs)>>: \brief Get information about the subgraphs assigned to each execution provider (EP) and the nodes within.
getter/setter pair
SessionEndProfiling ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> out)>>: \brief End profiling and return filename of the profile data
getter/setter pair
SessionGetEpDeviceForInputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Pointer<OrtEpDevice>> inputs_ep_devices, Size num_inputs)>>: \brief Get the OrtEpDevice (if available) for each input of the session.
getter/setter pair
SessionGetEpDeviceForOutputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Pointer<OrtEpDevice>> outputs_ep_devices, Size num_outputs)>>: \brief Get the EP device assigned to each session output.
getter/setter pair
SessionGetInputCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Size> out)>>: \brief Get input count for a session
getter/setter pair
SessionGetInputName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Size index, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> value)>>: \brief Get input name
getter/setter pair
SessionGetInputTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Size index, Pointer<Pointer<OrtTypeInfo>> type_info)>>: \brief Get input type information
getter/setter pair
SessionGetMemoryInfoForInputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Pointer<OrtMemoryInfo>> inputs_memory_info, Size num_inputs)>>: \brief Get the OrtMemoryInfo for each input of the session.
getter/setter pair
SessionGetMemoryInfoForOutputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Pointer<OrtMemoryInfo>> outputs_memory_info, Size num_outputs)>>: \brief Get the OrtMemoryInfo for each output of the session.
getter/setter pair
SessionGetModelMetadata ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Pointer<OrtModelMetadata>> out)>>: \brief Get ::OrtModelMetadata from an ::OrtSession
getter/setter pair
SessionGetOutputCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Size> out)>>: \brief Get output count for a session
getter/setter pair
SessionGetOutputName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Size index, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> value)>>: \brief Get output name
getter/setter pair
SessionGetOutputTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Size index, Pointer<Pointer<OrtTypeInfo>> type_info)>>: \brief Get output type information
getter/setter pair
SessionGetOverridableInitializerCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Size> out)>>: \brief Get overridable initializer count
getter/setter pair
SessionGetOverridableInitializerName ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Size index, Pointer<OrtAllocator> allocator, Pointer<Pointer<Char>> value)>>: \brief Get overridable initializer name
getter/setter pair
SessionGetOverridableInitializerTypeInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Size index, Pointer<Pointer<OrtTypeInfo>> type_info)>>: \brief Get overridable initializer type information
getter/setter pair
SessionGetProfilingStartTimeNs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> session, Pointer<Uint64> out)>>: \brief Return the time that profiling was started
getter/setter pair
SessionOptionsAppendExecutionProvider ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> provider_name, Pointer<Pointer<Char>> provider_options_keys, Pointer<Pointer<Char>> provider_options_values, Size num_keys)>>: \brief: Append execution provider to the session options. \paramin options \paramin provider_name - provider to add. \paramin provider_options_keys - keys to configure the provider options \paramin provider_options_values - values to configure the provider options \paramin num_keys - number of keys passed in
getter/setter pair
SessionOptionsAppendExecutionProvider_CANN ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtCANNProviderOptions> cann_options)>>: \brief Append CANN provider to session options
getter/setter pair
SessionOptionsAppendExecutionProvider_CUDA ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtCUDAProviderOptions> cuda_options)>>: \brief Append CUDA provider to session options
getter/setter pair
SessionOptionsAppendExecutionProvider_CUDA_V2 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtCUDAProviderOptionsV2> cuda_options)>>: \brief Append CUDA execution provider to the session options
getter/setter pair
SessionOptionsAppendExecutionProvider_Dnnl ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtDnnlProviderOptions> dnnl_options)>>: \brief Append dnnl provider to session options
getter/setter pair
SessionOptionsAppendExecutionProvider_MIGraphX ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtMIGraphXProviderOptions> migraphx_options)>>: \brief Append MIGraphX provider to session options
getter/setter pair
SessionOptionsAppendExecutionProvider_OpenVINO ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtOpenVINOProviderOptions> provider_options)>>: \brief Append OpenVINO execution provider to the session options
getter/setter pair
SessionOptionsAppendExecutionProvider_OpenVINO_V2 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Pointer<Char>> provider_options_keys, Pointer<Pointer<Char>> provider_options_values, Size num_keys)>>: \brief Append OpenVINO execution provider to the session options
getter/setter pair
SessionOptionsAppendExecutionProvider_ROCM ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtROCMProviderOptions> rocm_options)>>: \brief Append ROCM execution provider to the session options
getter/setter pair
SessionOptionsAppendExecutionProvider_TensorRT ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtTensorRTProviderOptions> tensorrt_options)>>: \brief Append TensorRT provider to session options
getter/setter pair
SessionOptionsAppendExecutionProvider_TensorRT_V2 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<OrtTensorRTProviderOptionsV2> tensorrt_options)>>: \brief Append TensorRT execution provider to the session options
getter/setter pair
SessionOptionsAppendExecutionProvider_V2 ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> session_options, Pointer<OrtEnv> env, Pointer<Pointer<OrtEpDevice>> ep_devices, Size num_ep_devices, Pointer<Pointer<Char>> ep_option_keys, Pointer<Pointer<Char>> ep_option_vals, Size num_ep_options)>>: \brief Append the execution provider that is responsible for the selected OrtEpDevice instances to the session options.
getter/setter pair
SessionOptionsAppendExecutionProvider_VitisAI ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Pointer<Char>> provider_options_keys, Pointer<Pointer<Char>> provider_options_values, Size num_keys)>>: \brief Append VitisAI provider to session options
getter/setter pair
SessionOptionsSetCustomCreateThreadFn ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, OrtCustomCreateThreadFn ort_custom_create_thread_fn)>>: \name SessionOptions @{ /** \brief Set custom thread creation function *
getter/setter pair
SessionOptionsSetCustomJoinThreadFn ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, OrtCustomJoinThreadFn ort_custom_join_thread_fn)>>: \brief Set custom thread join function
getter/setter pair
SessionOptionsSetCustomThreadCreationOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Void> ort_custom_thread_creation_options)>>: \brief Set creation options for custom thread
getter/setter pair
SessionOptionsSetEpSelectionPolicy ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> session_options, UnsignedInt policy)>>: \brief Set the execution provider selection policy for the session.
getter/setter pair
SessionOptionsSetEpSelectionPolicyDelegate ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> session_options, EpSelectionDelegate delegate, Pointer<Void> delegate_state)>>: \brief Set the execution provider selection policy delegate for the session.
getter/setter pair
SessionOptionsSetLoadCancellationFlag ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Bool cancel)>>: \brief sets load cancellation flag to abort session loading process.
getter/setter pair
SetCurrentGpuDeviceId ↔ Pointer<NativeFunction<OrtStatusPtr Function(Int device_id)>>: \brief Set current GPU device ID
getter/setter pair
SetDeterministicCompute ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Bool value)>>: \brief Set whether to use deterministic compute.
getter/setter pair
SetDimensions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorTypeAndShapeInfo> info, Pointer<Int64> dim_values, Size dim_count)>>: \brief Set shape information in ::OrtTensorTypeAndShapeInfo
getter/setter pair
SetEpDynamicOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSession> sess, Pointer<Pointer<Char>> keys, Pointer<Pointer<Char>> values, Size kv_len)>>: \brief Set DynamicOptions for EPs (Execution Providers)
getter/setter pair
SetGlobalCustomCreateThreadFn ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtThreadingOptions> tp_options, OrtCustomCreateThreadFn ort_custom_create_thread_fn)>>: \name OrtThreadingOptions @{ /** \brief Set custom thread creation function for global thread pools *
getter/setter pair
SetGlobalCustomJoinThreadFn ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtThreadingOptions> tp_options, OrtCustomJoinThreadFn ort_custom_join_thread_fn)>>: \brief Set custom thread join function for global thread pools
getter/setter pair
SetGlobalCustomThreadCreationOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtThreadingOptions> tp_options, Pointer<Void> ort_custom_thread_creation_options)>>: \brief Set custom thread creation options for global thread pools
getter/setter pair
SetGlobalDenormalAsZero ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtThreadingOptions> tp_options)>>: \brief Set threading flush-to-zero and denormal-as-zero
getter/setter pair
SetGlobalInterOpNumThreads ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtThreadingOptions> tp_options, Int inter_op_num_threads)>>: \brief Set global inter-op thread count
getter/setter pair
SetGlobalIntraOpNumThreads ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtThreadingOptions> tp_options, Int intra_op_num_threads)>>: \brief Set global intra-op thread count
getter/setter pair
SetGlobalIntraOpThreadAffinity ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtThreadingOptions> tp_options, Pointer<Char> affinity_string)>>: \brief Set affinities for intra op threads
getter/setter pair
SetGlobalSpinControl ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtThreadingOptions> tp_options, Int allow_spinning)>>: \brief Set global spin control options
getter/setter pair
SetInterOpNumThreads ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Int inter_op_num_threads)>>: \brief Sets the number of threads used to parallelize the execution of the graph
getter/setter pair
SetIntraOpNumThreads ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Int intra_op_num_threads)>>: \brief Sets the number of threads used to parallelize the execution within nodes
getter/setter pair
SetLanguageProjection ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> ort_env, UnsignedInt projection)>>: \brief Set language projection
getter/setter pair
SetOptimizedModelFilePath ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> optimized_model_filepath)>>: \brief Set filepath to save optimized model after graph level transformations
getter/setter pair
SetSessionExecutionMode ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, UnsignedInt execution_mode)>>: \brief Set execution mode
getter/setter pair
SetSessionGraphOptimizationLevel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, UnsignedInt graph_optimization_level)>>: \brief Set the optimization level to apply when loading a graph
getter/setter pair
SetSessionLogId ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Pointer<Char> logid)>>: \brief Set session log id
getter/setter pair
SetSessionLogSeverityLevel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Int session_log_severity_level)>>: \brief Set session log severity level
getter/setter pair
SetSessionLogVerbosityLevel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, Int session_log_verbosity_level)>>: \brief Set session log verbosity level
getter/setter pair
SetSymbolicDimensions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorTypeAndShapeInfo> info, Pointer<Pointer<Char>> dim_params, Size dim_params_length)>>: Set symbolic shape to type shape info
getter/setter pair
SetTensorElementType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorTypeAndShapeInfo> info, UnsignedInt type)>>: \brief Set element type in ::OrtTensorTypeAndShapeInfo
getter/setter pair
SetUserLoggingFunction ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSessionOptions> options, OrtLoggingFunction user_logging_function, Pointer<Void> user_logging_param)>>: \brief Set user logging function
getter/setter pair
ShapeInferContext_GetAttribute ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtShapeInferContext> context, Pointer<Char> attr_name, Pointer<Pointer<OrtOpAttr>> attr)>>: Get attribute from OrtShapeInferContext. Note that OrtShapeInferContext is a per-node context, one could only read attribute from current node.
getter/setter pair
ShapeInferContext_GetInputCount ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtShapeInferContext> context, Pointer<Size> out)>>: Get number of input from OrtShapeInferContext
getter/setter pair
ShapeInferContext_GetInputTypeShape ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtShapeInferContext> context, Size index, Pointer<Pointer<OrtTensorTypeAndShapeInfo>> info)>>: Get type and shape info of an input
getter/setter pair
ShapeInferContext_SetOutputTypeShape ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtShapeInferContext> context, Size index, Pointer<OrtTensorTypeAndShapeInfo> info)>>: Set type and shape info of an output
getter/setter pair
SynchronizeBoundInputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtIoBinding> binding_ptr)>>: \brief Synchronize bound inputs. The call may be necessary for some providers, such as cuda, in case the system that allocated bound memory operated on a different stream. However, the operation is provider specific and could be a no-op.
getter/setter pair
SynchronizeBoundOutputs ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtIoBinding> binding_ptr)>>: \brief Synchronize bound outputs. The call may be necessary for some providers, such as cuda, in case the system that allocated bound memory operated on a different stream. However, the operation is provider specific and could be a no-op.
getter/setter pair
SyncStream_GetHandle ↔ Pointer<NativeFunction<Pointer<Void> Function(Pointer<OrtSyncStream> stream)>>: \brief Get the native handle of the sync stream.
getter/setter pair
TensorAt ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> value, Pointer<Int64> location_values, Size location_values_count, Pointer<Pointer<Void>> out)>>: \brief Direct memory access to a specified tensor element
getter/setter pair
TensorTypeAndShape_HasShape ↔ Pointer<NativeFunction<Bool Function(Pointer<OrtTensorTypeAndShapeInfo> info)>>: @} /** \brief Fetch whether the tensor has shape information.
getter/setter pair
UnregisterAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<OrtMemoryInfo> mem_info)>>: \brief Unregister a custom allocator
getter/setter pair
UnregisterExecutionProviderLibrary ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> env, Pointer<Char> registration_name)>>: \brief Unregister an execution provider library with ORT.
getter/setter pair
UpdateCANNProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtCANNProviderOptions> cann_options, Pointer<Pointer<Char>> provider_options_keys, Pointer<Pointer<Char>> provider_options_values, Size num_keys)>>: \brief Set options in a CANN Execution Provider.
getter/setter pair
UpdateCUDAProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtCUDAProviderOptionsV2> cuda_options, Pointer<Pointer<Char>> provider_options_keys, Pointer<Pointer<Char>> provider_options_values, Size num_keys)>>: \brief Set options in a CUDA Execution Provider.
getter/setter pair
UpdateCUDAProviderOptionsWithValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtCUDAProviderOptionsV2> cuda_options, Pointer<Char> key, Pointer<Void> value)>>: Update CUDA EP provider option where its data type is pointer, for example 'user_compute_stream'. If the data type of the provider option can be represented by string please use UpdateCUDAProviderOptions.
getter/setter pair
UpdateDnnlProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtDnnlProviderOptions> dnnl_options, Pointer<Pointer<Char>> provider_options_keys, Pointer<Pointer<Char>> provider_options_values, Size num_keys)>>: \brief Set options in a oneDNN Execution Provider.
getter/setter pair
UpdateEnvWithCustomLogLevel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEnv> ort_env, UnsignedInt log_severity_level)>>: \brief Update the OrtEnv instance with custom log severity level
getter/setter pair
UpdateROCMProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtROCMProviderOptions> rocm_options, Pointer<Pointer<Char>> provider_options_keys, Pointer<Pointer<Char>> provider_options_values, Size num_keys)>>: \brief Set options in a ROCm Execution Provider.
getter/setter pair
UpdateTensorRTProviderOptions ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorRTProviderOptionsV2> tensorrt_options, Pointer<Pointer<Char>> provider_options_keys, Pointer<Pointer<Char>> provider_options_values, Size num_keys)>>: \brief Set options in a TensorRT Execution Provider.
getter/setter pair
UpdateTensorRTProviderOptionsWithValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtTensorRTProviderOptionsV2> tensorrt_options, Pointer<Char> key, Pointer<Void> value)>>: Update TensorRT EP provider option where its data type is pointer, for example 'user_compute_stream'. If the data type of the provider option can be represented by string please use UpdateTensorRTProviderOptions.
getter/setter pair
UseBlockSparseIndices ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<Int64> indices_shape, Size indices_shape_len, Pointer<Int32> indices_data)>>: The assigns BlockSparse format indices to the SparseTensor that was created by OrtApi::CreateSparseTensorWithValuesAsOrtValue above. It also sets OrtSparseFormat to ORT_SPARSE_BLOCK_SPARSE. This will not allocate any additional memory for data. The life span of indices_data buffer must eclipse the lifespan of this ::OrtValue.
getter/setter pair
UseCooIndices ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<Int64> indices_data, Size indices_num)>>: This assigns Coo format indices to the SparseTensor that was created by OrtApi::CreateSparseTensorWithValuesAsOrtValue above. It also sets OrtSparseFormat to ORT_SPARSE_COO. This will not allocate any additional memory for data. The life span of indices_data buffer should eclipse the life span of this ::OrtValue.
getter/setter pair
UseCsrIndices ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValue> ort_value, Pointer<Int64> inner_data, Size inner_num, Pointer<Int64> outer_data, Size outer_num)>>: The assigns CSR format indices to the SparseTensor that was created by OrtApi::CreateSparseTensorWithValuesAsOrtValue above. It also sets OrtSparseFormat to ORT_SPARSE_CSRC. This will not allocate any additional memory for data. The life spans of inner_data and outer_data buffers should eclipse the life span of this ::OrtValue.
getter/setter pair
ValueInfo_GetExternalInitializerInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Pointer<OrtExternalInitializerInfo>> info)>>: \brief Get information about an external initializer (e.g., filepath, file offset, byte size).
getter/setter pair
ValueInfo_GetInitializerValue ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Pointer<OrtValue>> initializer_value)>>: \brief Get the underlying initializer value, as an OrtValue, from the given OrtValueInfo.
getter/setter pair
ValueInfo_GetValueConsumers ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Pointer<OrtNode>> nodes, Pointer<Int64> input_indices, Size num_consumers)>>: \brief Returns information (OrtNode and input index) for all consumer nodes that use the value as an input.
getter/setter pair
ValueInfo_GetValueNumConsumers ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Size> num_consumers)>>: \brief Get the number of consumers of a value as a node input.
getter/setter pair
ValueInfo_GetValueProducer ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Pointer<OrtNode>> producer_node, Pointer<Size> producer_output_index)>>: \brief Get the OrtNode that produces the value represented by the given OrtValueInfo. Optionally returns the associated output index.
getter/setter pair
ValueInfo_IsConstantInitializer ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Bool> is_constant_initializer)>>: \brief Returns a boolean indicating if the given value is a constant initializer.
getter/setter pair
ValueInfo_IsFromOuterScope ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Bool> is_from_outer_scope)>>: \brief Returns a boolean indicating if the given value is defined in an outer scope.
getter/setter pair
ValueInfo_IsGraphOutput ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Bool> is_graph_output)>>: \brief Returns a boolean indicating if the given value is a graph output.
getter/setter pair
ValueInfo_IsOptionalGraphInput ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Bool> is_optional_graph_input)>>: \brief Returns a boolean indicating if the given value is an optional graph input.
getter/setter pair
ValueInfo_IsRequiredGraphInput ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtValueInfo> value_info, Pointer<Bool> is_required_graph_input)>>: \brief Returns a boolean indicating if the given value is a required graph input.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

OrtApi class final

Constructors

Properties

Methods

Operators

onnxruntime_generated library