Struct ipworksllm::Gemini

Properties   Methods   Events   Config Settings   Errors  

Provides an easy way to generate content with, create embeddings from, and list models of the Google Gemini API.

Syntax

ipworksllm::Gemini

Remarks

The Gemini struct provides a simple way to communicate with the Google Gemini API, the native API used by the Gemini family of models.

The struct models the Gemini protocol directly rather than translating it into another vendor's shape, so every concept the API defines, such as content parts, the top level system instruction, generation configuration, and safety settings, is exposed as it actually appears on the wire.

Selecting an Endpoint

Unlike providers that name the model in the request body, the Gemini API names it in the request path, together with the operation being invoked. The server_url property supplies the base of that path, and a request URL is built as {ServerURL}/models/{Model}:{operation}.

By default, the struct uses the official Google Gemini endpoint, https://generativelanguage.googleapis.com/v1beta. In most cases, the default endpoint is the correct choice. The server_url property should only be changed when connecting through a gateway or proxy that implements the Gemini API. No part of server_url is rewritten or normalized.

// Official Google service. The request URL becomes // https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent gemini.ServerURL = "https://generativelanguage.googleapis.com/v1beta"; gemini.APIKey = "..."; gemini.Model = "gemini-2.0-flash"; // A local or corporate gateway that exposes the same API. gemini.ServerURL = "https://llm-gateway.example.com/gemini/v1beta";

The api_key property is sent as an x-goog-api-key header. When it is left empty, no x-goog-api-key header is sent at all, which supports gateways that inject credentials of their own.

Generating Content

A conversation is built up in the contents properties, which holds a list of GeminiContent items. The add_content method is a convenient way to append an item with a given Role (user or model) and Text.

The Gemini API does not accept a content item whose role is system. A system instruction is instead supplied through the system_instruction property, which is sent as a top level systemInstruction field alongside the conversation.

gemini.APIKey = "..."; gemini.Model = "gemini-2.0-flash"; gemini.SystemInstruction = "You are a concise assistant."; gemini.AddContent("user", "What is the capital of France?"); gemini.GenerateContent(); // The model's reply is now the last item in Contents. string reply = gemini.Contents[gemini.Contents.Count - 1].Text; Console.WriteLine(reply);

Content Parts

The Gemini API carries the content of every conversation item as an array of parts, each of which holds one member such as text, inlineData, functionCall, or functionResponse. For the common case, the Text property of a GeminiContent simply holds plain text, and the struct wraps it in a single part automatically.

When richer content is needed, set Text to a raw JSON array of parts. If the value begins with [ after leading whitespace is ignored, the struct sends it verbatim as the item's parts. This allows any part type supported by the API to be used without modeling each type separately.

The same rule applies in the opposite direction. When a reply consists of a single text part, the appended item holds just that text. When a reply contains multiple parts, or any part that is not text, the appended item holds the raw parts array, so that sending the conversation back to the model reproduces the model turn. For a streamed reply, all of the text that arrived is coalesced into a single leading text part, so the original ordering of text relative to interleaved parts such as functionCall is not preserved.

Note that a reply which carries no parts at all produces an appended item whose Text is empty. Such an entry should be removed, or filled in, before the conversation is sent again, because the API may reject a content item with no parts.

// Supplying an image alongside text, using the raw parts form. gemini.AddContent("user", "[{\"text\":\"What is in this picture?\"}," + " {\"inlineData\":{\"mimeType\":\"image/jpeg\"," + " \"data\":\"" + base64Image + "\"}}]"); gemini.GenerateContent();

Streaming

Setting the stream property to True before calling generate_content sends the request to the streamGenerateContent operation, with the alt=sse query parameter that selects server-sent events. The on_content_delta event then fires once for each incremental fragment of text, reporting the fragment in Delta.

Once the stream completes, the fully assembled reply is appended to contents and the on_function_call event fires for any function call the reply contained, exactly as in the non streaming case.

gemini.Stream = true; gemini.OnContentDelta += (s, e) => { Console.Write(e.Delta); }; gemini.AddContent("user", "Write a short poem about the sea."); gemini.GenerateContent();

Function Calling

Tools give the model an opportunity to request that the calling application execute a function on its behalf. A tool is declared by first queuing its parameters with one or more calls to add_tool_param, then calling add_tool to consume the queued parameters and append a new GeminiTool item to the tools properties. Each item is sent as one function declaration of the request's tools array.

When the model decides to call a function, its reply contains a functionCall part and the on_function_call event fires once per part, providing the function Name and the ArgsJson arguments object the model produced.

To return the function's result, append an item with role user whose Text is a raw parts array holding a functionResponse part, then call generate_content again so the model can incorporate the result. The struct does not build that part for the application, because the shape of a function's result is defined by the application, not by the API; the raw parts form is what makes it expressible.

gemini.AddToolParam("location", "string", "The city and state, e.g. San Francisco, CA", true); gemini.AddTool("get_weather", "Gets the current weather for a location."); bool functionCalled = false; gemini.OnFunctionCall += (s, e) => { // Execute the requested function and append its result as a // 'functionResponse' part. string result = GetWeather(e.ArgsJson); gemini.AddContent("user", "[{\"functionResponse\":{\"name\":\"" + e.Name + "\"," + " \"response\":{\"result\":\"" + result + "\"}}}]"); functionCalled = true; }; gemini.AddContent("user", "What is the weather like in Boston?"); gemini.GenerateContent(); // If a function was called, FunctionCall fired and a 'functionResponse' item // was appended above. Calling GenerateContent again lets the model produce a // final answer. if (functionCalled) gemini.GenerateContent();

Safety Settings

The safety_settings property holds the request's safetySettings array as raw JSON text, which is sent verbatim. Each element pairs a category with a threshold. Because the value is passed through untouched, every category and threshold the API defines is reachable, and categories added by the API later require no change to the struct.

gemini.SafetySettings = "[{\"category\":\"HARM_CATEGORY_HARASSMENT\"," + " \"threshold\":\"BLOCK_ONLY_HIGH\"}," + " {\"category\":\"HARM_CATEGORY_HATE_SPEECH\"," + " \"threshold\":\"BLOCK_MEDIUM_AND_ABOVE\"}]";

When this property is left empty, the safetySettings field is omitted from the request entirely and the server's own defaults apply.

Embeddings and Listing Models

The create_embedding method creates an embedding vector for every item of the embeddings properties. All of the texts are sent to {ServerURL}/models/{selected model}:batchEmbedContents in a single request, and the OutputVector property of each item is set to the vector created for that item's InputText, as JSON text containing an array of floating point numbers. Because Google publishes models dedicated to embeddings, the EmbeddingModel configuration setting may be used to select one without disturbing the model property used for generation.

gemini.Config("EmbeddingModel=gemini-embedding-001"); gemini.Embeddings.Add(new GeminiEmbedding("What is the meaning of life?")); gemini.Embeddings.Add(new GeminiEmbedding("How much wood would a woodchuck chuck?")); gemini.CreateEmbedding(); foreach (GeminiEmbedding embedding in gemini.Embeddings) { Console.WriteLine(embedding.OutputVector); }

The list_models method sends a request to {ServerURL}/models and fires the on_model_list event once for each model reported by the server. The Gemini API reports each model under its resource name, which carries a models/ prefix; either that value or the bare identifier that follows it may be assigned to model. Note that the endpoint returns a single page of results; the struct reports the models on that first page and does not follow the page token to subsequent pages.

gemini.OnModelList += (s, e) => { Console.WriteLine(e.Name + " (" + e.DisplayName + ")"); }; gemini.ListModels();

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksLLM. Due to this, the Gemini struct cannot be disposed of automatically. Please, call the dispose(&self) method of Gemini when you have finished using the instance.

Property List

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

api_key property (Gemini Struct)

The API key used to authenticate with the endpoint.

Syntax

fn api_key(&self) -> Result<String, IPWorksLLMError> 
fn set_api_key(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_api_key_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property specifies the API key used to authenticate requests. When set, it is sent as an x-goog-api-key header.

When this property is left empty, no x-goog-api-key header is sent at all. This supports gateways placed in front of the API that supply credentials of their own.

Data Type

String

content_count property (Gemini Struct)

The number of records in the Content arrays.

Syntax

fn content_count(&self) -> Result<i32, IPWorksLLMError> 
fn set_content_count(&self, value : i32) ->  Option<IPWorksLLMError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• content_role
• content_text

The array indices start at 0 and end at content_count - 1.

Data Type

i32

content_role property (Gemini Struct)

The role of the item's author.

Syntax

fn content_role(&self, ContentIndex : i32) -> Result<String, IPWorksLLMError> 
fn set_content_role(&self, ContentIndex : i32, value : &str) ->  Option<IPWorksLLMError> 
fn set_content_role_ref(&self, ContentIndex : i32, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property identifies the role of the item's author. The Gemini API accepts only user and model here; a system instruction is supplied through the system_instruction property instead.

The ContentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the content_count property.

Data Type

String

content_text property (Gemini Struct)

The text of the item.

Syntax

fn content_text(&self, ContentIndex : i32) -> Result<String, IPWorksLLMError> 
fn set_content_text(&self, ContentIndex : i32, value : &str) ->  Option<IPWorksLLMError> 
fn set_content_text_ref(&self, ContentIndex : i32, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property normally holds the plain text of the item, which is sent as a single part holding a text field.

When the value instead begins with [, it is treated as a raw JSON parts array and sent verbatim, which is how parts such as inlineData, fileData, or functionResponse are supplied.

The same distinction applies to a reply appended by generate_content. A reply consisting of one text part is stored as plain text, while a reply holding several parts, or any part that is not text, is stored as the raw parts array.

The ContentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the content_count property.

Data Type

String

embedding_count property (Gemini Struct)

The number of records in the Embedding arrays.

Syntax

fn embedding_count(&self) -> Result<i32, IPWorksLLMError> 
fn set_embedding_count(&self, value : i32) ->  Option<IPWorksLLMError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• embedding_input_text
• embedding_output_vector

The array indices start at 0 and end at embedding_count - 1.

Data Type

i32

embedding_input_text property (Gemini Struct)

The text to create an embedding for.

Syntax

fn embedding_input_text(&self, EmbeddingIndex : i32) -> Result<String, IPWorksLLMError> 
fn set_embedding_input_text(&self, EmbeddingIndex : i32, value : &str) ->  Option<IPWorksLLMError> 
fn set_embedding_input_text_ref(&self, EmbeddingIndex : i32, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property holds the text that create_embedding sends to the server for this item. It must not be empty; otherwise create_embedding fails with error 802 before anything is sent.

The EmbeddingIndex parameter specifies the index of the item in the array. The size of the array is controlled by the embedding_count property.

Data Type

String

embedding_output_vector property (Gemini Struct)

The embedding vector created for the text, as a JSON array.

Syntax

fn embedding_output_vector(&self, EmbeddingIndex : i32) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

This property holds the embedding vector the server created for embedding_input_text, as JSON text containing an array of floating point numbers, for example [0.0023064255,-0.009327292,0.015797347]. Each number is reported exactly as the server wrote it; only the whitespace between the numbers is removed. The number of elements depends on the model, and on the EmbeddingDimensions configuration setting when that setting is set.

This property is empty until create_embedding succeeds. create_embedding clears it in every item before its request is sent, so a failed call never leaves a vector from an earlier call next to new text.

The EmbeddingIndex parameter specifies the index of the item in the array. The size of the array is controlled by the embedding_count property.

This property is read-only.

Data Type

String

firewall_auto_detect property (Gemini Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self) -> Result<bool, IPWorksLLMError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<IPWorksLLMError> 

Default Value

false

Remarks

Data Type

bool

firewall_type property (Gemini Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self) -> Result<i32, IPWorksLLMError> 
fn set_firewall_type(&self, value : i32) ->  Option<IPWorksLLMError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (Gemini Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self) -> Result<String, IPWorksLLMError> 
fn set_firewall_host(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

String

firewall_password property (Gemini Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self) -> Result<String, IPWorksLLMError> 
fn set_firewall_password(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (Gemini Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self) -> Result<i32, IPWorksLLMError> 
fn set_firewall_port(&self, value : i32) ->  Option<IPWorksLLMError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

Data Type

i32

firewall_user property (Gemini Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self) -> Result<String, IPWorksLLMError> 
fn set_firewall_user(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

max_output_tokens property (Gemini Struct)

The maximum number of tokens the model may generate in a reply.

Syntax

fn max_output_tokens(&self) -> Result<i32, IPWorksLLMError> 
fn set_max_output_tokens(&self, value : i32) ->  Option<IPWorksLLMError> 

Default Value

0

Remarks

This property specifies an upper bound on the number of tokens the model may produce for a single reply. When the bound is reached, generation stops and the FinishReason configuration setting reports MAX_TOKENS.

When this property is left at 0 (the default), the maxOutputTokens field is omitted from the request's generationConfig object and the server's own default is used.

Data Type

i32

model property (Gemini Struct)

The model used when generating content.

Syntax

fn model(&self) -> Result<String, IPWorksLLMError> 
fn set_model(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_model_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property specifies the identifier of the model that will process the request, for example gemini-2.0-flash. This property must be set before calling generate_content, and before calling create_embedding unless the EmbeddingModel configuration setting supplies a model of its own.

The Gemini API names the model inside the request path, as {ServerURL}/models/{Model}:{operation}. A value that already carries the models/ resource name prefix, which is the form on_model_list reports, is accepted as well; the prefix is not duplicated in the request path.

The list_models method may be used to discover the model identifiers the endpoint accepts.

Data Type

String

proxy_auth_scheme property (Gemini Struct)

The type of authorization to perform when connecting to the proxy.

Syntax

fn proxy_auth_scheme(&self) -> Result<i32, IPWorksLLMError> 
fn set_proxy_auth_scheme(&self, value : i32) ->  Option<IPWorksLLMError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the struct will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

Data Type

i32

proxy_auto_detect property (Gemini Struct)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fn proxy_auto_detect(&self) -> Result<bool, IPWorksLLMError> 
fn set_proxy_auto_detect(&self, value : bool) ->  Option<IPWorksLLMError> 

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

bool

proxy_password property (Gemini Struct)

A password if authentication is to be used for the proxy.

Syntax

fn proxy_password(&self) -> Result<String, IPWorksLLMError> 
fn set_proxy_password(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

proxy_port property (Gemini Struct)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fn proxy_port(&self) -> Result<i32, IPWorksLLMError> 
fn set_proxy_port(&self, value : i32) ->  Option<IPWorksLLMError> 

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

Data Type

i32

proxy_server property (Gemini Struct)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fn proxy_server(&self) -> Result<String, IPWorksLLMError> 
fn set_proxy_server(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

proxy_ssl property (Gemini Struct)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fn proxy_ssl(&self) -> Result<i32, IPWorksLLMError> 
fn set_proxy_ssl(&self, value : i32) ->  Option<IPWorksLLMError> 

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

i32

proxy_user property (Gemini Struct)

A username if authentication is to be used for the proxy.

Syntax

fn proxy_user(&self) -> Result<String, IPWorksLLMError> 
fn set_proxy_user(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_proxy_user_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

safety_settings property (Gemini Struct)

The raw JSON array of safety settings sent with the request.

Syntax

fn safety_settings(&self) -> Result<String, IPWorksLLMError> 
fn set_safety_settings(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_safety_settings_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property holds the request's safetySettings array as raw JSON text, which is sent verbatim. Each element of the array is an object with a category and a threshold, which together adjust how aggressively the model blocks a category of content.

The value is passed through untouched, so every category and threshold the API defines is reachable without the struct having to model each one.

gemini.SafetySettings = "[{\"category\":\"HARM_CATEGORY_HARASSMENT\"," + " \"threshold\":\"BLOCK_ONLY_HIGH\"}]";

In the Async Edition (nsoftware.async.IPWorksLLM), the property is set the same way and the request is awaited:

gemini.SafetySettings = "[{\"category\":\"HARM_CATEGORY_HARASSMENT\"," + " \"threshold\":\"BLOCK_ONLY_HIGH\"}]"; await gemini.GenerateContent();

When this property is left empty (the default), the safetySettings field is omitted from the request entirely and the server's own defaults apply.

Data Type

String

server_url property (Gemini Struct)

The base URL of the Gemini API endpoint.

Syntax

fn server_url(&self) -> Result<String, IPWorksLLMError> 
fn set_server_url(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_server_url_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

"https://generativelanguage.googleapis.com/v1beta"

Remarks

This property specifies the base URL used to build request URLs. The Gemini API names the model inside the request path, so a request URL is formed as {ServerURL}/models/{Model}:{operation}, for example https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent.

No part of this value is rewritten, so endpoints that include or omit a version segment (such as /v1beta) are both supported.

By default, the struct uses the official Google Gemini endpoint, https://generativelanguage.googleapis.com/v1beta. In most cases, the default endpoint is the correct choice. This property should only be changed when connecting through a gateway or proxy that implements the Gemini API.

Data Type

String

ssl_accept_server_cert_effective_date property (Gemini Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (Gemini Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (Gemini Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (Gemini Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (Gemini Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (Gemini Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (Gemini Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (Gemini Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (Gemini Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self) -> Result<bool, IPWorksLLMError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (Gemini Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (Gemini Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (Gemini Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (Gemini Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self) -> Result<i32, IPWorksLLMError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (Gemini Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (Gemini Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (Gemini Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self) -> Result<Vec<u8>, IPWorksLLMError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksLLMError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksLLMError> 

Default Value

"MY"

Remarks

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec<u8>

ssl_accept_server_cert_store_password property (Gemini Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self) -> Result<String, IPWorksLLMError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_accept_server_cert_store_type property (Gemini Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self) -> Result<i32, IPWorksLLMError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksLLMError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (Gemini Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (Gemini Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (Gemini Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (Gemini Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (Gemini Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (Gemini Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self) -> Result<i32, IPWorksLLMError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (Gemini Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (Gemini Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self) -> Result<String, IPWorksLLMError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (Gemini Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self) -> Result<Vec<u8>, IPWorksLLMError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksLLMError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec<u8>

ssl_cert_effective_date property (Gemini Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (Gemini Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (Gemini Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (Gemini Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (Gemini Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (Gemini Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (Gemini Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (Gemini Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (Gemini Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self) -> Result<bool, IPWorksLLMError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (Gemini Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (Gemini Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (Gemini Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (Gemini Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self) -> Result<i32, IPWorksLLMError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (Gemini Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (Gemini Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (Gemini Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self) -> Result<Vec<u8>, IPWorksLLMError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksLLMError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksLLMError> 

Default Value

"MY"

Remarks

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec<u8>

ssl_cert_store_password property (Gemini Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self) -> Result<String, IPWorksLLMError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (Gemini Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self) -> Result<i32, IPWorksLLMError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksLLMError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (Gemini Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (Gemini Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (Gemini Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (Gemini Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (Gemini Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (Gemini Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self) -> Result<i32, IPWorksLLMError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (Gemini Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (Gemini Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self) -> Result<String, IPWorksLLMError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (Gemini Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self) -> Result<Vec<u8>, IPWorksLLMError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksLLMError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec<u8>

ssl_provider property (Gemini Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fn ssl_provider(&self) -> Result<i32, IPWorksLLMError> 
fn set_ssl_provider(&self, value : i32) ->  Option<IPWorksLLMError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

ssl_server_cert_effective_date property (Gemini Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (Gemini Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (Gemini Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (Gemini Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (Gemini Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (Gemini Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (Gemini Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (Gemini Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (Gemini Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self) -> Result<bool, IPWorksLLMError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (Gemini Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (Gemini Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (Gemini Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (Gemini Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self) -> Result<i32, IPWorksLLMError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (Gemini Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (Gemini Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_store property (Gemini Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self) -> Result<Vec<u8>, IPWorksLLMError> 

Default Value

"MY"

Remarks

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec<u8>

ssl_server_cert_store_password property (Gemini Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (Gemini Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self) -> Result<i32, IPWorksLLMError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (Gemini Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (Gemini Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (Gemini Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (Gemini Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_usage property (Gemini Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (Gemini Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self) -> Result<i32, IPWorksLLMError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (Gemini Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_server_cert_subject property (Gemini Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self) -> Result<String, IPWorksLLMError> 

Default Value

""

Remarks

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (Gemini Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self) -> Result<Vec<u8>, IPWorksLLMError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec<u8>

stop_sequences property (Gemini Struct)

A comma-separated list of sequences where the model should stop generating.

Syntax

fn stop_sequences(&self) -> Result<String, IPWorksLLMError> 
fn set_stop_sequences(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_stop_sequences_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property specifies up to a handful of sequences, separated by commas, at which the model will stop generating further tokens. For example, setting this to END,STOP causes generation to stop as soon as either END or STOP is produced.

When this property is left empty (the default), the stopSequences field is omitted from the request's generationConfig object.

Data Type

String

stream property (Gemini Struct)

Whether the reply should be streamed.

Syntax

fn stream(&self) -> Result<bool, IPWorksLLMError> 
fn set_stream(&self, value : bool) ->  Option<IPWorksLLMError> 

Default Value

false

Remarks

When this property is set to True, generate_content sends its request to the streamGenerateContent operation and the on_content_delta event fires once for each incremental fragment of the reply as it is received.

In both cases, once the reply has been fully received it is appended to contents as a new item with role model, and the on_function_call event fires for each function the model called.

The default value is False.

Data Type

bool

system_instruction property (Gemini Struct)

The system instruction sent alongside the conversation.

Syntax

fn system_instruction(&self) -> Result<String, IPWorksLLMError> 
fn set_system_instruction(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_system_instruction_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property specifies the system instruction, which gives the model context and instructions that apply to the whole conversation, such as a role to adopt or a goal to pursue.

The Gemini API does not accept a content item whose role is system. The system instruction is instead a top level systemInstruction field of the request, which is what this property supplies.

When this property is left empty (the default), the systemInstruction field is omitted from the request entirely.

Data Type

String

temperature property (Gemini Struct)

The sampling temperature to use for the reply.

Syntax

fn temperature(&self) -> Result<String, IPWorksLLMError> 
fn set_temperature(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_temperature_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property specifies the amount of randomness injected into the response. Higher values make the output more varied, while lower values make it more focused and deterministic.

When this property is left empty (the default), the temperature field is omitted from the request's generationConfig object and the server's own default is used.

Data Type

String

timeout property (Gemini Struct)

The timeout for operations in seconds.

Syntax

fn timeout(&self) -> Result<i32, IPWorksLLMError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksLLMError> 

Default Value

60

Remarks

This property specifies the timeout period in seconds for operations performed by the struct.

If this is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If this is set to a positive value, the struct will wait for the operation to complete before returning control. If the timeout expires before the operation completes, the struct throws an exception.

Note that all timeouts are inactivity timeouts, meaning the timeout period is extended by value specified in this property when any amount of data is successfully sent or received.

Data Type

i32

tool_count property (Gemini Struct)

The number of records in the Tool arrays.

Syntax

fn tool_count(&self) -> Result<i32, IPWorksLLMError> 
fn set_tool_count(&self, value : i32) ->  Option<IPWorksLLMError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tool_description
• tool_name
• tool_parameters_schema

The array indices start at 0 and end at tool_count - 1.

Data Type

i32

tool_description property (Gemini Struct)

A description of what the tool does.

Syntax

fn tool_description(&self, ToolIndex : i32) -> Result<String, IPWorksLLMError> 
fn set_tool_description(&self, ToolIndex : i32, value : &str) ->  Option<IPWorksLLMError> 
fn set_tool_description_ref(&self, ToolIndex : i32, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property holds a natural language description of what the tool does and when it should be used. A thorough description materially improves the model's ability to choose the tool appropriately.

The ToolIndex parameter specifies the index of the item in the array. The size of the array is controlled by the tool_count property.

Data Type

String

tool_name property (Gemini Struct)

The unique name associated with the tool.

Syntax

fn tool_name(&self, ToolIndex : i32) -> Result<String, IPWorksLLMError> 
fn set_tool_name(&self, ToolIndex : i32, value : &str) ->  Option<IPWorksLLMError> 
fn set_tool_name_ref(&self, ToolIndex : i32, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property identifies the unique name associated with the tool. The model uses this name when it calls the tool, and it is reported as the Name parameter of the on_function_call event.

The ToolIndex parameter specifies the index of the item in the array. The size of the array is controlled by the tool_count property.

Data Type

String

tool_parameters_schema property (Gemini Struct)

The raw JSON Schema describing the tool's parameters.

Syntax

fn tool_parameters_schema(&self, ToolIndex : i32) -> Result<String, IPWorksLLMError> 
fn set_tool_parameters_schema(&self, ToolIndex : i32, value : &str) ->  Option<IPWorksLLMError> 
fn set_tool_parameters_schema_ref(&self, ToolIndex : i32, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property holds the raw JSON Schema object describing the parameters the tool expects, as built from calls to add_tool_param or as set directly. It is sent as the parameters member of the tool's function declaration.

When left empty, a schema equivalent to {"type": "object"} (no parameters) is used.

The ToolIndex parameter specifies the index of the item in the array. The size of the array is controlled by the tool_count property.

Data Type

String

top_k property (Gemini Struct)

The number of top choices the model samples from.

Syntax

fn top_k(&self) -> Result<i32, IPWorksLLMError> 
fn set_top_k(&self, value : i32) ->  Option<IPWorksLLMError> 

Default Value

0

Remarks

This property specifies that the model should sample only from the given number of most likely tokens at each step, which removes long tail low probability responses.

When this property is left at 0 (the default), the topK field is omitted from the request's generationConfig object and the server's own default is used.

Data Type

i32

top_p property (Gemini Struct)

The nucleus sampling cutoff to use for the reply.

Syntax

fn top_p(&self) -> Result<String, IPWorksLLMError> 
fn set_top_p(&self, value : &str) ->  Option<IPWorksLLMError> 
fn set_top_p_ref(&self, value : &String) ->  Option<IPWorksLLMError> 

Default Value

""

Remarks

This property specifies the cumulative probability cutoff used for nucleus sampling. The model considers only the most likely tokens whose probabilities sum to this value.

When this property is left empty (the default), the topP field is omitted from the request's generationConfig object and the server's own default is used.

Data Type

String

add_content method (Gemini Struct)

Appends an item to the Contents collection.

Syntax

fn add_content(&self, role : &str, text : &str) -> Result<(), IPWorksLLMError>

Remarks

This method appends a new item with the given Role (user or model) and Text to the contents properties. It is a convenience equivalent to adding an item to the collection directly.

Text normally holds plain text, which is sent as a single part holding a text field. When Text instead begins with [, it is treated as a raw JSON parts array and sent verbatim, which is how parts such as inlineData or functionResponse are supplied.

A system instruction cannot be added through this method; use the system_instruction property instead.

add_tool method (Gemini Struct)

Appends a tool to the Tools collection.

Syntax

fn add_tool(&self, name : &str, description : &str) -> Result<(), IPWorksLLMError>

Remarks

This method appends a new GeminiTool item, with the given Name and Description, to the tools properties.

Any parameters queued by prior calls to add_tool_param are consumed and used to build the new tool's parameter schema; the parameter queue is then cleared.

Example: gemini.AddToolParam("location", "string", "The city and state, e.g. San Francisco, CA", true); gemini.AddTool("get_weather", "Gets the current weather for a location.");

In the Async Edition (nsoftware.async.IPWorksLLM), both calls are awaited:

await gemini.AddToolParam("location", "string", "The city and state, e.g. San Francisco, CA", true); await gemini.AddTool("get_weather", "Gets the current weather for a location.");

add_tool_param method (Gemini Struct)

Queues a parameter to be included in the next tool added via AddTool.

Syntax

fn add_tool_param(&self, name : &str, param_type : &str, description : &str, required : bool) -> Result<(), IPWorksLLMError>

Remarks

This method queues a parameter to be included in the JSON Schema of the next tool appended via add_tool.

Name specifies the parameter's name.

ParamType specifies the parameter's JSON Schema type, such as string, number, boolean, or object.

Description specifies a natural language description of the parameter, which helps the model determine appropriate values for it.

Required specifies whether the model must supply a value for this parameter whenever it calls the function.

Queued parameters are consumed, and the queue is cleared, the next time add_tool is called.

config method (Gemini Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) -> Result<String, IPWorksLLMError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_embedding method (Gemini Struct)

Creates an embedding vector for each item of the Embeddings collection.

Syntax

fn create_embedding(&self) -> Result<(), IPWorksLLMError>

Remarks

This method sends the InputText of every item in the embeddings properties to {ServerURL}/models/{selected model}:batchEmbedContents in a single request, and sets the OutputVector of each item to the embedding vector the server created for its text, as JSON text containing an array of floating point numbers. Each item becomes one request of the batch, so every text receives its own vector.

The model specified by the EmbeddingModel configuration setting is used, or, when that setting is empty, the model specified by model. Google publishes models dedicated to embeddings, such as gemini-embedding-001, which is what EmbeddingModel is normally set to. The EmbeddingDimensions and EmbeddingTaskType configuration settings, when set, are sent with every item of the batch.

gemini.Config("EmbeddingModel=gemini-embedding-001"); gemini.Embeddings.Add(new GeminiEmbedding("What is the meaning of life?")); gemini.Embeddings.Add(new GeminiEmbedding("How much wood would a woodchuck chuck?")); gemini.CreateEmbedding(); string firstVector = gemini.Embeddings[0].OutputVector;

In the Async Edition (nsoftware.async.IPWorksLLM), the same operation is awaited:

await gemini.Config("EmbeddingModel=gemini-embedding-001"); gemini.Embeddings.Add(new GeminiEmbedding("What is the meaning of life?")); gemini.Embeddings.Add(new GeminiEmbedding("How much wood would a woodchuck chuck?")); await gemini.CreateEmbedding(); string firstVector = gemini.Embeddings[0].OutputVector;

All items are sent in one request; this method never splits them over several requests. The server limits the size of that request and of each text in it, and a request beyond a limit fails with error 801, which carries the server's own explanation; spread a large set of texts over several calls in that case.

The OutputVector of every item is cleared before the request is sent, so after an error no item holds a vector. When the reply does not hold exactly one embedding for each item, this method fails with error 803. On success, the PromptTokens and TotalTokens configuration settings report the tokens the server counted; both are 0 when the reply carries no token count, which the Gemini API does not always include.

This method fails with error 802 when embeddings is empty, when an item's InputText is empty, or when neither the EmbeddingModel configuration setting nor model is set. Nothing is appended to contents by this method.

do_events method (Gemini Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksLLMError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

generate_content method (Gemini Struct)

Sends the current conversation to the model and appends the reply.

Syntax

fn generate_content(&self) -> Result<(), IPWorksLLMError>

Remarks

This method sends the entire contents properties, together with system_instruction, tools, safety_settings, and every request property that has been set away from its default value, to {ServerURL}/models/{Model}:generateContent. Properties left at their default values are omitted from the request JSON, and the generationConfig object itself is omitted unless at least one of its properties has been set.

On success, the model's reply is appended to contents as a new item whose role is model. When the reply is a single part of text, that text is stored directly; when the reply holds several parts, or any part that is not text, the raw parts array is stored instead so that the model turn can be reproduced exactly.

A reply the server blocked returns success with no candidate content and raises error 803; the block reason is included in the error message when the server provides one, and the full reply is available via the RawResponse configuration setting.

When the model calls one or more functions, the on_function_call event fires once for each call. To continue the conversation, append an item with role user whose Text is a raw parts array holding the matching functionResponse parts, then call this method again.

The model property must be set before calling this method.

The following example sends a short conversation and reads the reply back out of contents.

gemini.APIKey = "..."; gemini.Model = "gemini-2.0-flash"; gemini.SystemInstruction = "You are a concise assistant."; gemini.AddContent("user", "What is the capital of France?"); gemini.GenerateContent(); string reply = gemini.Contents[gemini.Contents.Count - 1].Text;

In the Async Edition (nsoftware.async.IPWorksLLM), the same operation is awaited:

gemini.APIKey = "..."; gemini.Model = "gemini-2.0-flash"; gemini.SystemInstruction = "You are a concise assistant."; await gemini.AddContent("user", "What is the capital of France?"); await gemini.GenerateContent(); string reply = gemini.Contents[gemini.Contents.Count - 1].Text;

interrupt method (Gemini Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), IPWorksLLMError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_models method (Gemini Struct)

Retrieves the list of models available from the endpoint.

Syntax

fn list_models(&self) -> Result<(), IPWorksLLMError>

Remarks

This method sends a request to {ServerURL}/models. The on_model_list event fires once for each model reported by the server.

This method is typically used to discover which model identifiers are valid for the model property.

The endpoint returns a single page of results. This method reports the models on that first page and does not follow the page token to any subsequent page.

The following example prints every model the endpoint reports.

gemini.OnModelList += (s, e) => { Console.WriteLine(e.Name + " (" + e.DisplayName + ")"); }; gemini.ListModels();

In the Async Edition (nsoftware.async.IPWorksLLM), the handler returns a task and the request is awaited:

gemini.OnModelList += async (s, e) => { Console.WriteLine(e.Name + " (" + e.DisplayName + ")"); }; await gemini.ListModels();

reset method (Gemini Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksLLMError>

Remarks

This method will reset the struct's properties to their default values.

on_connected event (Gemini Struct)

Fired immediately after a connection completes (or fails).

Syntax

// GeminiConnectedEventArgs carries the Gemini Connected event's parameters.
pub struct GeminiConnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// GeminiConnectedEvent defines the signature of the Gemini Connected event's handler function.
pub trait GeminiConnectedEvent {
  fn on_connected(&self, sender : Gemini, e : &mut GeminiConnectedEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_connected(&self) -> &'a dyn GeminiConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn GeminiConnectedEvent);
  ...
}

Remarks

If the connection is made normally, status_code is 0 and description is "OK".

If the connection fails, status_code has the error code returned by the Transmission Control Protocol (TCP)/IP stack. description contains a description of this code. The value of status_code is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_connection_status event (Gemini Struct)

Fired to indicate changes in the connection state.

Syntax

// GeminiConnectionStatusEventArgs carries the Gemini ConnectionStatus event's parameters.
pub struct GeminiConnectionStatusEventArgs {
  fn connection_event(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// GeminiConnectionStatusEvent defines the signature of the Gemini ConnectionStatus event's handler function.
pub trait GeminiConnectionStatusEvent {
  fn on_connection_status(&self, sender : Gemini, e : &mut GeminiConnectionStatusEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_connection_status(&self) -> &'a dyn GeminiConnectionStatusEvent;
  pub fn set_on_connection_status(&mut self, value : &'a dyn GeminiConnectionStatusEvent);
  ...
}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The connection_event parameter indicates the type of connection event. Values may include the following:

on_content_delta event (Gemini Struct)

Fires once for each incremental fragment of a streamed reply.

Syntax

// GeminiContentDeltaEventArgs carries the Gemini ContentDelta event's parameters.
pub struct GeminiContentDeltaEventArgs {
  fn delta(&self) -> &String
}

// GeminiContentDeltaEvent defines the signature of the Gemini ContentDelta event's handler function.
pub trait GeminiContentDeltaEvent {
  fn on_content_delta(&self, sender : Gemini, e : &mut GeminiContentDeltaEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_content_delta(&self) -> &'a dyn GeminiContentDeltaEvent;
  pub fn set_on_content_delta(&mut self, value : &'a dyn GeminiContentDeltaEvent);
  ...
}

Remarks

This event fires when stream is set to True and generate_content is called. It fires once for each incremental fragment of text the server sends as the reply is generated.

Delta holds the fragment itself. Concatenating Delta across every occurrence of this event reconstructs the text of the reply; the assembled reply is also appended to contents once streaming completes.

Parts of a streamed reply that are not text, such as a function call, do not fire this event; they are reported through on_function_call once the stream completes.

The following example prints the reply as it arrives.

gemini.Stream = true; gemini.OnContentDelta += (s, e) => { Console.Write(e.Delta); }; gemini.AddContent("user", "Write a short poem about the sea."); gemini.GenerateContent();

In the Async Edition (nsoftware.async.IPWorksLLM), the handler returns a task and the request is awaited:

gemini.Stream = true; gemini.OnContentDelta += async (s, e) => { Console.Write(e.Delta); }; await gemini.AddContent("user", "Write a short poem about the sea."); await gemini.GenerateContent();

on_disconnected event (Gemini Struct)

Fired when a connection is closed.

Syntax

// GeminiDisconnectedEventArgs carries the Gemini Disconnected event's parameters.
pub struct GeminiDisconnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// GeminiDisconnectedEvent defines the signature of the Gemini Disconnected event's handler function.
pub trait GeminiDisconnectedEvent {
  fn on_disconnected(&self, sender : Gemini, e : &mut GeminiDisconnectedEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_disconnected(&self) -> &'a dyn GeminiDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn GeminiDisconnectedEvent);
  ...
}

Remarks

If the connection is broken normally, status_code is 0 and description is "OK".

If the connection is broken for any other reason, status_code has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. description contains a description of this code. The value of status_code is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

on_end_transfer event (Gemini Struct)

Fired when a document finishes transferring.

Syntax

// GeminiEndTransferEventArgs carries the Gemini EndTransfer event's parameters.
pub struct GeminiEndTransferEventArgs {
  fn direction(&self) -> i32
}

// GeminiEndTransferEvent defines the signature of the Gemini EndTransfer event's handler function.
pub trait GeminiEndTransferEvent {
  fn on_end_transfer(&self, sender : Gemini, e : &mut GeminiEndTransferEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn GeminiEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn GeminiEndTransferEvent);
  ...
}

Remarks

This event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error event (Gemini Struct)

Fired when information is available about errors during data delivery.

Syntax

// GeminiErrorEventArgs carries the Gemini Error event's parameters.
pub struct GeminiErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// GeminiErrorEvent defines the signature of the Gemini Error event's handler function.
pub trait GeminiErrorEvent {
  fn on_error(&self, sender : Gemini, e : &mut GeminiErrorEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_error(&self) -> &'a dyn GeminiErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn GeminiErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_function_call event (Gemini Struct)

Fires once for each function the model calls.

Syntax

// GeminiFunctionCallEventArgs carries the Gemini FunctionCall event's parameters.
pub struct GeminiFunctionCallEventArgs {
  fn name(&self) -> &String
  fn args_json(&self) -> &String
}

// GeminiFunctionCallEvent defines the signature of the Gemini FunctionCall event's handler function.
pub trait GeminiFunctionCallEvent {
  fn on_function_call(&self, sender : Gemini, e : &mut GeminiFunctionCallEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_function_call(&self) -> &'a dyn GeminiFunctionCallEvent;
  pub fn set_on_function_call(&mut self, value : &'a dyn GeminiFunctionCallEvent);
  ...
}

Remarks

This event fires when the model's reply contains one or more functionCall parts, once per part. It fires for both streamed and non streamed replies.

Name is the name of the function, matching the tool_name property of the GeminiTool item that declared it. ArgsJson holds the JSON arguments object the model produced for the call.

To continue the conversation, append an item with role user whose Text is a raw parts array holding a functionResponse part whose name is Name and whose response is the function's result, then call generate_content again.

The following example returns the function's result as a functionResponse part and lets the model produce a final reply.

bool functionCalled = false; gemini.OnFunctionCall += (s, e) => { gemini.AddContent("user", "[{\"functionResponse\":{\"name\":\"" + e.Name + "\"," + " \"response\":{\"result\":\"" + GetWeather(e.ArgsJson) + "\"}}}]"); functionCalled = true; }; gemini.AddContent("user", "What is the weather like in Boston?"); gemini.GenerateContent(); if (functionCalled) gemini.GenerateContent();

In the Async Edition (nsoftware.async.IPWorksLLM), the handler returns a task and each request is awaited:

bool functionCalled = false; gemini.OnFunctionCall += async (s, e) => { await gemini.AddContent("user", "[{\"functionResponse\":{\"name\":\"" + e.Name + "\"," + " \"response\":{\"result\":\"" + GetWeather(e.ArgsJson) + "\"}}}]"); functionCalled = true; }; await gemini.AddContent("user", "What is the weather like in Boston?"); await gemini.GenerateContent(); if (functionCalled) await gemini.GenerateContent();

on_header event (Gemini Struct)

Fired every time a header line comes in.

Syntax

// GeminiHeaderEventArgs carries the Gemini Header event's parameters.
pub struct GeminiHeaderEventArgs {
  fn field(&self) -> &String
  fn value(&self) -> &String
}

// GeminiHeaderEvent defines the signature of the Gemini Header event's handler function.
pub trait GeminiHeaderEvent {
  fn on_header(&self, sender : Gemini, e : &mut GeminiHeaderEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_header(&self) -> &'a dyn GeminiHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn GeminiHeaderEvent);
  ...
}

Remarks

The field parameter contains the name of the HTTP header (which is the same as it is delivered). The value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the field parameter contains "" (empty string).

on_log event (Gemini Struct)

Fired once for each log message.

Syntax

// GeminiLogEventArgs carries the Gemini Log event's parameters.
pub struct GeminiLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// GeminiLogEvent defines the signature of the Gemini Log event's handler function.
pub trait GeminiLogEvent {
  fn on_log(&self, sender : Gemini, e : &mut GeminiLogEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_log(&self) -> &'a dyn GeminiLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn GeminiLogEvent);
  ...
}

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

log_level indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

message is the log entry.

log_type identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_model_list event (Gemini Struct)

Fires once for each model reported by the server.

Syntax

// GeminiModelListEventArgs carries the Gemini ModelList event's parameters.
pub struct GeminiModelListEventArgs {
  fn name(&self) -> &String
  fn display_name(&self) -> &String
}

// GeminiModelListEvent defines the signature of the Gemini ModelList event's handler function.
pub trait GeminiModelListEvent {
  fn on_model_list(&self, sender : Gemini, e : &mut GeminiModelListEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_model_list(&self) -> &'a dyn GeminiModelListEvent;
  pub fn set_on_model_list(&mut self, value : &'a dyn GeminiModelListEvent);
  ...
}

Remarks

This event fires once for each model returned in response to a call to list_models.

Name holds the model's resource name, which the Gemini API reports with a models/ prefix, as in models/gemini-2.0-flash. Either that value or the bare identifier that follows the prefix may be assigned to model. DisplayName holds a human readable name for the model.

on_redirect event (Gemini Struct)

Fired when a redirection is received from the server.

Syntax

// GeminiRedirectEventArgs carries the Gemini Redirect event's parameters.
pub struct GeminiRedirectEventArgs {
  fn location(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// GeminiRedirectEvent defines the signature of the Gemini Redirect event's handler function.
pub trait GeminiRedirectEvent {
  fn on_redirect(&self, sender : Gemini, e : &mut GeminiRedirectEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_redirect(&self) -> &'a dyn GeminiRedirectEvent;
  pub fn set_on_redirect(&mut self, value : &'a dyn GeminiRedirectEvent);
  ...
}

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The accept parameter is always True by default, but if you do not want to follow the redirection, accept may be set to False, in which case the struct fails with an error. location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_set_cookie event (Gemini Struct)

Fired for every cookie set by the server.

Syntax

// GeminiSetCookieEventArgs carries the Gemini SetCookie event's parameters.
pub struct GeminiSetCookieEventArgs {
  fn name(&self) -> &String
  fn value(&self) -> &String
  fn expires(&self) -> &String
  fn domain(&self) -> &String
  fn path(&self) -> &String
  fn secure(&self) -> bool
}

// GeminiSetCookieEvent defines the signature of the Gemini SetCookie event's handler function.
pub trait GeminiSetCookieEvent {
  fn on_set_cookie(&self, sender : Gemini, e : &mut GeminiSetCookieEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_set_cookie(&self) -> &'a dyn GeminiSetCookieEvent;
  pub fn set_on_set_cookie(&mut self, value : &'a dyn GeminiSetCookieEvent);
  ...
}

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The name parameter contains the name of the cookie, with the corresponding value supplied in the value parameter.

The expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.

The path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.

The secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

on_ssl_server_authentication event (Gemini Struct)

Fired after the server presents its certificate to the client.

Syntax

// GeminiSSLServerAuthenticationEventArgs carries the Gemini SSLServerAuthentication event's parameters.
pub struct GeminiSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// GeminiSSLServerAuthenticationEvent defines the signature of the Gemini SSLServerAuthentication event's handler function.
pub trait GeminiSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : Gemini, e : &mut GeminiSSLServerAuthenticationEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn GeminiSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn GeminiSSLServerAuthenticationEvent);
  ...
}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When accept is False, status shows why the verification failed (otherwise, status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the accept parameter to True.

on_ssl_status event (Gemini Struct)

Fired when secure connection progress messages are available.

Syntax

// GeminiSSLStatusEventArgs carries the Gemini SSLStatus event's parameters.
pub struct GeminiSSLStatusEventArgs {
  fn message(&self) -> &String
}

// GeminiSSLStatusEvent defines the signature of the Gemini SSLStatus event's handler function.
pub trait GeminiSSLStatusEvent {
  fn on_ssl_status(&self, sender : Gemini, e : &mut GeminiSSLStatusEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn GeminiSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn GeminiSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer event (Gemini Struct)

Fired when a document starts transferring (after the headers).

Syntax

// GeminiStartTransferEventArgs carries the Gemini StartTransfer event's parameters.
pub struct GeminiStartTransferEventArgs {
  fn direction(&self) -> i32
}

// GeminiStartTransferEvent defines the signature of the Gemini StartTransfer event's handler function.
pub trait GeminiStartTransferEvent {
  fn on_start_transfer(&self, sender : Gemini, e : &mut GeminiStartTransferEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn GeminiStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn GeminiStartTransferEvent);
  ...
}

Remarks

This event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_status event (Gemini Struct)

Fired when the HTTP status line is received from the server.

Syntax

// GeminiStatusEventArgs carries the Gemini Status event's parameters.
pub struct GeminiStatusEventArgs {
  fn http_version(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// GeminiStatusEvent defines the signature of the Gemini Status event's handler function.
pub trait GeminiStatusEvent {
  fn on_status(&self, sender : Gemini, e : &mut GeminiStatusEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_status(&self) -> &'a dyn GeminiStatusEvent;
  pub fn set_on_status(&mut self, value : &'a dyn GeminiStatusEvent);
  ...
}

Remarks

http_version is a string containing the HTTP version string as returned from the server (e.g., "1.1").

status_code contains the HTTP status code (e.g., 200), and description the associated message returned by the server (e.g., "OK").

on_transfer event (Gemini Struct)

Fired while a document transfers (delivers document).

Syntax

// GeminiTransferEventArgs carries the Gemini Transfer event's parameters.
pub struct GeminiTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
}

// GeminiTransferEvent defines the signature of the Gemini Transfer event's handler function.
pub trait GeminiTransferEvent {
  fn on_transfer(&self, sender : Gemini, e : &mut GeminiTransferEventArgs);
}

impl <'a> Gemini<'a> {
  pub fn on_transfer(&self) -> &'a dyn GeminiTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn GeminiTransferEvent);
  ...
}

Remarks

The text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The bytes_transferred parameter contains the number of bytes transferred in this direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (Gemini Struct)

Gemini Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (Gemini Struct)

Gemini Errors

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors