You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

llama.native.safellavaimageembedhandle.md 2.7 kB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. # SafeLlavaImageEmbedHandle
  2. Namespace: LLama.Native
  3. A Reference to a llava Image Embed handle
  4. ```csharp
  5. public sealed class SafeLlavaImageEmbedHandle : SafeLLamaHandleBase, System.IDisposable
  6. ```
  7. Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.constrainedexecution.criticalfinalizerobject) → [SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.safehandle) → [SafeLLamaHandleBase](./llama.native.safellamahandlebase.md) → [SafeLlavaImageEmbedHandle](./llama.native.safellavaimageembedhandle.md)<br>
  8. Implements [IDisposable](https://docs.microsoft.com/en-us/dotnet/api/system.idisposable)
  9. ## Properties
  10. ### **IsInvalid**
  11. ```csharp
  12. public bool IsInvalid { get; }
  13. ```
  14. #### Property Value
  15. [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
  16. ### **IsClosed**
  17. ```csharp
  18. public bool IsClosed { get; }
  19. ```
  20. #### Property Value
  21. [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
  22. ## Methods
  23. ### **CreateFromFileName(SafeLlavaModelHandle, LLamaContext, String)**
  24. Create an image embed from an image file
  25. ```csharp
  26. public static SafeLlavaImageEmbedHandle CreateFromFileName(SafeLlavaModelHandle ctxLlava, LLamaContext ctxLlama, string image)
  27. ```
  28. #### Parameters
  29. `ctxLlava` [SafeLlavaModelHandle](./llama.native.safellavamodelhandle.md)<br>
  30. `ctxLlama` [LLamaContext](./llama.llamacontext.md)<br>
  31. `image` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
  32. Path to the image file. Supported formats:
  33. JPGPNGBMPTGA
  34. #### Returns
  35. [SafeLlavaImageEmbedHandle](./llama.native.safellavaimageembedhandle.md)<br>
  36. #### Exceptions
  37. [InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)<br>
  38. ### **CreateFromMemory(SafeLlavaModelHandle, LLamaContext, Byte[])**
  39. Create an image embed from the bytes of an image.
  40. ```csharp
  41. public static SafeLlavaImageEmbedHandle CreateFromMemory(SafeLlavaModelHandle ctxLlava, LLamaContext ctxLlama, Byte[] image)
  42. ```
  43. #### Parameters
  44. `ctxLlava` [SafeLlavaModelHandle](./llama.native.safellavamodelhandle.md)<br>
  45. `ctxLlama` [LLamaContext](./llama.llamacontext.md)<br>
  46. `image` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)<br>
  47. Image bytes. Supported formats:
  48. JPGPNGBMPTGA
  49. #### Returns
  50. [SafeLlavaImageEmbedHandle](./llama.native.safellavaimageembedhandle.md)<br>
  51. ### **ReleaseHandle()**
  52. ```csharp
  53. protected bool ReleaseHandle()
  54. ```
  55. #### Returns
  56. [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>