Gemini Component

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 component provides a simple way to communicate with the Google Gemini API, the native API used by the Gemini family of models.

The component 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 ServerURL property supplies the base of that path, and a request URL is built as {ServerURL}/models/{Model}:{operation}.

By default, the component uses the official Google Gemini endpoint, https://generativelanguage.googleapis.com/v1beta. In most cases, the default endpoint is the correct choice. The ServerURL property should only be changed when connecting through a gateway or proxy that implements the Gemini API. No part of ServerURL 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 APIKey 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 AddContent 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 SystemInstruction 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 component 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 component 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 GenerateContent sends the request to the streamGenerateContent operation, with the alt=sse query parameter that selects server-sent events. The ContentDelta 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 FunctionCall 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 AddToolParam, then calling AddTool 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 FunctionCall 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 GenerateContent again so the model can incorporate the result. The component 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 SafetySettings 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 component.

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 CreateEmbedding 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 ListModels method sends a request to {ServerURL}/models and fires the ModelList 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 component 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();

Property List

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

Method List

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

Event List

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

Config Settings

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

APIKey Property (Gemini Component)

The API key used to authenticate with the endpoint.

Syntax

func (obj *Gemini) APIKey() (string, error)
func (obj *Gemini) SetAPIKey(value string) error

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

ContentCount Property (Gemini Component)

The number of records in the Content arrays.

Syntax

func (obj *Gemini) ContentCount() (int32, error)
func (obj *Gemini) SetContentCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• ContentRole
• ContentText

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

Data Type

int32

ContentRole Property (Gemini Component)

The role of the item's author.

Syntax

func (obj *Gemini) ContentRole(ContentIndex int32) (string, error)
func (obj *Gemini) SetContentRole(ContentIndex int32, value string) error

Default Value

""

Remarks

The role of the item's author.

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 SystemInstruction property instead.

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

Data Type

string

ContentText Property (Gemini Component)

The text of the item.

Syntax

func (obj *Gemini) ContentText(ContentIndex int32) (string, error)
func (obj *Gemini) SetContentText(ContentIndex int32, value string) error

Default Value

""

Remarks

The text of the item.

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 GenerateContent. 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 ContentCount property.

Data Type

string

EmbeddingCount Property (Gemini Component)

The number of records in the Embedding arrays.

Syntax

func (obj *Gemini) EmbeddingCount() (int32, error)
func (obj *Gemini) SetEmbeddingCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• EmbeddingInputText
• EmbeddingOutputVector

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

Data Type

int32

EmbeddingInputText Property (Gemini Component)

The text to create an embedding for.

Syntax

func (obj *Gemini) EmbeddingInputText(EmbeddingIndex int32) (string, error)
func (obj *Gemini) SetEmbeddingInputText(EmbeddingIndex int32, value string) error

Default Value

""

Remarks

The text to create an embedding for.

This property holds the text that CreateEmbedding sends to the server for this item. It must not be empty; otherwise CreateEmbedding 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 EmbeddingCount property.

Data Type

string

EmbeddingOutputVector Property (Gemini Component)

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

Syntax

func (obj *Gemini) EmbeddingOutputVector(EmbeddingIndex int32) (string, error)

Default Value

""

Remarks

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

This property holds the embedding vector the server created for EmbeddingInputText, 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 CreateEmbedding succeeds. CreateEmbedding 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 EmbeddingCount property.

This property is read-only.

Data Type

string

FirewallAutoDetect Property (Gemini Component)

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

Syntax

func (obj *Gemini) FirewallAutoDetect() (bool, error)
func (obj *Gemini) SetFirewallAutoDetect(value bool) error

Default Value

false

Remarks

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

Data Type

bool

FirewallType Property (Gemini Component)

The type of firewall to connect through.

Syntax

func (obj *Gemini) FirewallType() (int32, error)
func (obj *Gemini) SetFirewallType(value int32) error

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

int32

FirewallHost Property (Gemini Component)

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

Syntax

func (obj *Gemini) FirewallHost() (string, error)
func (obj *Gemini) SetFirewallHost(value string) error

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost 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 component fails with an error.

Data Type

string

FirewallPassword Property (Gemini Component)

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

Syntax

func (obj *Gemini) FirewallPassword() (string, error)
func (obj *Gemini) SetFirewallPassword(value string) error

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component fails with an error.

Data Type

string

FirewallPort Property (Gemini Component)

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

Syntax

func (obj *Gemini) FirewallPort() (int32, error)
func (obj *Gemini) SetFirewallPort(value int32) error

Default Value

0

Remarks

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

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

Data Type

int32

FirewallUser Property (Gemini Component)

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

Syntax

func (obj *Gemini) FirewallUser() (string, error)
func (obj *Gemini) SetFirewallUser(value string) error

Default Value

""

Remarks

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

Data Type

string

MaxOutputTokens Property (Gemini Component)

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

Syntax

func (obj *Gemini) MaxOutputTokens() (int32, error)
func (obj *Gemini) SetMaxOutputTokens(value int32) error

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

int32

Model Property (Gemini Component)

The model used when generating content.

Syntax

func (obj *Gemini) Model() (string, error)
func (obj *Gemini) SetModel(value string) error

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 GenerateContent, and before calling CreateEmbedding 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 ModelList reports, is accepted as well; the prefix is not duplicated in the request path.

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

Data Type

string

ProxyAuthScheme Property (Gemini Component)

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

Syntax

func (obj *Gemini) ProxyAuthScheme() (int32, error)
func (obj *Gemini) SetProxyAuthScheme(value int32) error

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 ProxyUser and ProxyPassword properties are set.

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

int32

ProxyAutoDetect Property (Gemini Component)

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

Syntax

func (obj *Gemini) ProxyAutoDetect() (bool, error)
func (obj *Gemini) SetProxyAutoDetect(value bool) error

Default Value

false

Remarks

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

Data Type

bool

ProxyPassword Property (Gemini Component)

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

Syntax

func (obj *Gemini) ProxyPassword() (string, error)
func (obj *Gemini) SetProxyPassword(value string) error

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

string

ProxyPort Property (Gemini Component)

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

Syntax

func (obj *Gemini) ProxyPort() (int32, error)
func (obj *Gemini) SetProxyPort(value int32) error

Default Value

80

Remarks

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

Data Type

int32

ProxyServer Property (Gemini Component)

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

Syntax

func (obj *Gemini) ProxyServer() (string, error)
func (obj *Gemini) SetProxyServer(value string) error

Default Value

""

Remarks

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

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

Data Type

string

ProxySSL Property (Gemini Component)

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

Syntax

func (obj *Gemini) ProxySSL() (int32, error)
func (obj *Gemini) SetProxySSL(value int32) error

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

int32

ProxyUser Property (Gemini Component)

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

Syntax

func (obj *Gemini) ProxyUser() (string, error)
func (obj *Gemini) SetProxyUser(value string) error

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

string

SafetySettings Property (Gemini Component)

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

Syntax

func (obj *Gemini) SafetySettings() (string, error)
func (obj *Gemini) SetSafetySettings(value string) error

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 component 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

ServerURL Property (Gemini Component)

The base URL of the Gemini API endpoint.

Syntax

func (obj *Gemini) ServerURL() (string, error)
func (obj *Gemini) SetServerURL(value string) error

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 component 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

SSLAcceptServerCertEffectiveDate Property (Gemini Component)

The date on which this certificate becomes valid.

Syntax

func (obj *Gemini) SSLAcceptServerCertEffectiveDate() (string, error)

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

SSLAcceptServerCertExpirationDate Property (Gemini Component)

The date on which the certificate expires.

Syntax

func (obj *Gemini) SSLAcceptServerCertExpirationDate() (string, error)

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

SSLAcceptServerCertExtendedKeyUsage Property (Gemini Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *Gemini) SSLAcceptServerCertExtendedKeyUsage() (string, error)

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

SSLAcceptServerCertFingerprint Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLAcceptServerCertFingerprint() (string, error)

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

SSLAcceptServerCertFingerprintSHA1 Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLAcceptServerCertFingerprintSHA1() (string, error)

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

SSLAcceptServerCertFingerprintSHA256 Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLAcceptServerCertFingerprintSHA256() (string, error)

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

SSLAcceptServerCertIssuer Property (Gemini Component)

The issuer of the certificate.

Syntax

func (obj *Gemini) SSLAcceptServerCertIssuer() (string, error)

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

SSLAcceptServerCertPrivateKey Property (Gemini Component)

The private key of the certificate (if available).

Syntax

func (obj *Gemini) SSLAcceptServerCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SSLAcceptServerCertPrivateKeyAvailable Property (Gemini Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *Gemini) SSLAcceptServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SSLAcceptServerCertPrivateKeyContainer Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLAcceptServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKey Property (Gemini Component)

The public key of the certificate.

Syntax

func (obj *Gemini) SSLAcceptServerCertPublicKey() (string, error)

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

SSLAcceptServerCertPublicKeyAlgorithm Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLAcceptServerCertPublicKeyAlgorithm() (string, error)

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

SSLAcceptServerCertPublicKeyLength Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLAcceptServerCertPublicKeyLength() (int32, error)

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

int32

SSLAcceptServerCertSerialNumber Property (Gemini Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *Gemini) SSLAcceptServerCertSerialNumber() (string, error)

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

SSLAcceptServerCertSignatureAlgorithm Property (Gemini Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *Gemini) SSLAcceptServerCertSignatureAlgorithm() (string, error)

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

SSLAcceptServerCertStore Property (Gemini Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *Gemini) SSLAcceptServerCertStore() ([]byte, error)
func (obj *Gemini) SetSSLAcceptServerCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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

[]byte

SSLAcceptServerCertStorePassword Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLAcceptServerCertStorePassword() (string, error)
func (obj *Gemini) SetSSLAcceptServerCertStorePassword(value string) error

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

SSLAcceptServerCertStoreType Property (Gemini Component)

The type of certificate store for this certificate.

Syntax

func (obj *Gemini) SSLAcceptServerCertStoreType() (int32, error)
func (obj *Gemini) SetSSLAcceptServerCertStoreType(value int32) error

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 type of certificate store for this certificate.

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

Data Type

int32

SSLAcceptServerCertSubjectAltNames Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLAcceptServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintMD5 Property (Gemini Component)

The MD5 hash of the certificate.

Syntax

func (obj *Gemini) SSLAcceptServerCertThumbprintMD5() (string, error)

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

SSLAcceptServerCertThumbprintSHA1 Property (Gemini Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *Gemini) SSLAcceptServerCertThumbprintSHA1() (string, error)

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

SSLAcceptServerCertThumbprintSHA256 Property (Gemini Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *Gemini) SSLAcceptServerCertThumbprintSHA256() (string, error)

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

SSLAcceptServerCertUsage Property (Gemini Component)

The text description of UsageFlags .

Syntax

func (obj *Gemini) SSLAcceptServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

SSLAcceptServerCertUsageFlags Property (Gemini Component)

The flags that show intended use for the certificate.

Syntax

func (obj *Gemini) SSLAcceptServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

int32

SSLAcceptServerCertVersion Property (Gemini Component)

The certificate's version number.

Syntax

func (obj *Gemini) SSLAcceptServerCertVersion() (string, error)

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

SSLAcceptServerCertSubject Property (Gemini Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *Gemini) SSLAcceptServerCertSubject() (string, error)
func (obj *Gemini) SetSSLAcceptServerCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

SSLAcceptServerCertEncoded Property (Gemini Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *Gemini) SSLAcceptServerCertEncoded() ([]byte, error)
func (obj *Gemini) SetSSLAcceptServerCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

SSLCertEffectiveDate Property (Gemini Component)

The date on which this certificate becomes valid.

Syntax

func (obj *Gemini) SSLCertEffectiveDate() (string, error)

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

SSLCertExpirationDate Property (Gemini Component)

The date on which the certificate expires.

Syntax

func (obj *Gemini) SSLCertExpirationDate() (string, error)

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

SSLCertExtendedKeyUsage Property (Gemini Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *Gemini) SSLCertExtendedKeyUsage() (string, error)

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

SSLCertFingerprint Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLCertFingerprint() (string, error)

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

SSLCertFingerprintSHA1 Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLCertFingerprintSHA1() (string, error)

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

SSLCertFingerprintSHA256 Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLCertFingerprintSHA256() (string, error)

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

SSLCertIssuer Property (Gemini Component)

The issuer of the certificate.

Syntax

func (obj *Gemini) SSLCertIssuer() (string, error)

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

SSLCertPrivateKey Property (Gemini Component)

The private key of the certificate (if available).

Syntax

func (obj *Gemini) SSLCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SSLCertPrivateKeyAvailable Property (Gemini Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *Gemini) SSLCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SSLCertPrivateKeyContainer Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertPublicKey Property (Gemini Component)

The public key of the certificate.

Syntax

func (obj *Gemini) SSLCertPublicKey() (string, error)

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

SSLCertPublicKeyAlgorithm Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLCertPublicKeyAlgorithm() (string, error)

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

SSLCertPublicKeyLength Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLCertPublicKeyLength() (int32, error)

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

int32

SSLCertSerialNumber Property (Gemini Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *Gemini) SSLCertSerialNumber() (string, error)

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

SSLCertSignatureAlgorithm Property (Gemini Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *Gemini) SSLCertSignatureAlgorithm() (string, error)

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

SSLCertStore Property (Gemini Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *Gemini) SSLCertStore() ([]byte, error)
func (obj *Gemini) SetSSLCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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

[]byte

SSLCertStorePassword Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLCertStorePassword() (string, error)
func (obj *Gemini) SetSSLCertStorePassword(value string) error

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

SSLCertStoreType Property (Gemini Component)

The type of certificate store for this certificate.

Syntax

func (obj *Gemini) SSLCertStoreType() (int32, error)
func (obj *Gemini) SetSSLCertStoreType(value int32) error

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 type of certificate store for this certificate.

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

Data Type

int32

SSLCertSubjectAltNames Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertThumbprintMD5 Property (Gemini Component)

The MD5 hash of the certificate.

Syntax

func (obj *Gemini) SSLCertThumbprintMD5() (string, error)

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

SSLCertThumbprintSHA1 Property (Gemini Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *Gemini) SSLCertThumbprintSHA1() (string, error)

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

SSLCertThumbprintSHA256 Property (Gemini Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *Gemini) SSLCertThumbprintSHA256() (string, error)

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

SSLCertUsage Property (Gemini Component)

The text description of UsageFlags .

Syntax

func (obj *Gemini) SSLCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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

SSLCertUsageFlags Property (Gemini Component)

The flags that show intended use for the certificate.

Syntax

func (obj *Gemini) SSLCertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

int32

SSLCertVersion Property (Gemini Component)

The certificate's version number.

Syntax

func (obj *Gemini) SSLCertVersion() (string, error)

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

SSLCertSubject Property (Gemini Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *Gemini) SSLCertSubject() (string, error)
func (obj *Gemini) SetSSLCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

SSLCertEncoded Property (Gemini Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *Gemini) SSLCertEncoded() ([]byte, error)
func (obj *Gemini) SetSSLCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

SSLProvider Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLProvider() (int32, error)
func (obj *Gemini) SetSSLProvider(value int32) error

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 component 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 component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the component 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

int32

SSLServerCertEffectiveDate Property (Gemini Component)

The date on which this certificate becomes valid.

Syntax

func (obj *Gemini) SSLServerCertEffectiveDate() (string, error)

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

SSLServerCertExpirationDate Property (Gemini Component)

The date on which the certificate expires.

Syntax

func (obj *Gemini) SSLServerCertExpirationDate() (string, error)

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

SSLServerCertExtendedKeyUsage Property (Gemini Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *Gemini) SSLServerCertExtendedKeyUsage() (string, error)

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

SSLServerCertFingerprint Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLServerCertFingerprint() (string, error)

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

SSLServerCertFingerprintSHA1 Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLServerCertFingerprintSHA1() (string, error)

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

SSLServerCertFingerprintSHA256 Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLServerCertFingerprintSHA256() (string, error)

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

SSLServerCertIssuer Property (Gemini Component)

The issuer of the certificate.

Syntax

func (obj *Gemini) SSLServerCertIssuer() (string, error)

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

SSLServerCertPrivateKey Property (Gemini Component)

The private key of the certificate (if available).

Syntax

func (obj *Gemini) SSLServerCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SSLServerCertPrivateKeyAvailable Property (Gemini Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *Gemini) SSLServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SSLServerCertPrivateKeyContainer Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertPublicKey Property (Gemini Component)

The public key of the certificate.

Syntax

func (obj *Gemini) SSLServerCertPublicKey() (string, error)

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

SSLServerCertPublicKeyAlgorithm Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLServerCertPublicKeyAlgorithm() (string, error)

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

SSLServerCertPublicKeyLength Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLServerCertPublicKeyLength() (int32, error)

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

int32

SSLServerCertSerialNumber Property (Gemini Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *Gemini) SSLServerCertSerialNumber() (string, error)

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

SSLServerCertSignatureAlgorithm Property (Gemini Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *Gemini) SSLServerCertSignatureAlgorithm() (string, error)

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

SSLServerCertStore Property (Gemini Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *Gemini) SSLServerCertStore() ([]byte, error)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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

[]byte

SSLServerCertStorePassword Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLServerCertStorePassword() (string, error)

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

SSLServerCertStoreType Property (Gemini Component)

The type of certificate store for this certificate.

Syntax

func (obj *Gemini) SSLServerCertStoreType() (int32, error)

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 type of certificate store for this certificate.

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

This property is read-only.

Data Type

int32

SSLServerCertSubjectAltNames Property (Gemini Component)

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

Syntax

func (obj *Gemini) SSLServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertThumbprintMD5 Property (Gemini Component)

The MD5 hash of the certificate.

Syntax

func (obj *Gemini) SSLServerCertThumbprintMD5() (string, error)

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

SSLServerCertThumbprintSHA1 Property (Gemini Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *Gemini) SSLServerCertThumbprintSHA1() (string, error)

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

SSLServerCertThumbprintSHA256 Property (Gemini Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *Gemini) SSLServerCertThumbprintSHA256() (string, error)

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

SSLServerCertUsage Property (Gemini Component)

The text description of UsageFlags .

Syntax

func (obj *Gemini) SSLServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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

SSLServerCertUsageFlags Property (Gemini Component)

The flags that show intended use for the certificate.

Syntax

func (obj *Gemini) SSLServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

int32

SSLServerCertVersion Property (Gemini Component)

The certificate's version number.

Syntax

func (obj *Gemini) SSLServerCertVersion() (string, error)

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

SSLServerCertSubject Property (Gemini Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *Gemini) SSLServerCertSubject() (string, error)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

SSLServerCertEncoded Property (Gemini Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *Gemini) SSLServerCertEncoded() ([]byte, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

[]byte

StopSequences Property (Gemini Component)

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

Syntax

func (obj *Gemini) StopSequences() (string, error)
func (obj *Gemini) SetStopSequences(value string) error

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 Component)

Whether the reply should be streamed.

Syntax

func (obj *Gemini) Stream() (bool, error)
func (obj *Gemini) SetStream(value bool) error

Default Value

false

Remarks

When this property is set to True, GenerateContent sends its request to the streamGenerateContent operation and the ContentDelta 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 FunctionCall event fires for each function the model called.

The default value is False.

Data Type

bool

SystemInstruction Property (Gemini Component)

The system instruction sent alongside the conversation.

Syntax

func (obj *Gemini) SystemInstruction() (string, error)
func (obj *Gemini) SetSystemInstruction(value string) error

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 Component)

The sampling temperature to use for the reply.

Syntax

func (obj *Gemini) Temperature() (string, error)
func (obj *Gemini) SetTemperature(value string) error

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 Component)

The timeout for operations in seconds.

Syntax

func (obj *Gemini) Timeout() (int32, error)
func (obj *Gemini) SetTimeout(value int32) error

Default Value

60

Remarks

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

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 component will wait for the operation to complete before returning control. If the timeout expires before the operation completes, the component 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

int32

ToolCount Property (Gemini Component)

The number of records in the Tool arrays.

Syntax

func (obj *Gemini) ToolCount() (int32, error)
func (obj *Gemini) SetToolCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• ToolDescription
• ToolName
• ToolParametersSchema

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

Data Type

int32

ToolDescription Property (Gemini Component)

A description of what the tool does.

Syntax

func (obj *Gemini) ToolDescription(ToolIndex int32) (string, error)
func (obj *Gemini) SetToolDescription(ToolIndex int32, value string) error

Default Value

""

Remarks

A description of what the tool does.

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 ToolCount property.

Data Type

string

ToolName Property (Gemini Component)

The unique name associated with the tool.

Syntax

func (obj *Gemini) ToolName(ToolIndex int32) (string, error)
func (obj *Gemini) SetToolName(ToolIndex int32, value string) error

Default Value

""

Remarks

The unique name associated with the tool.

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 FunctionCall event.

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

Data Type

string

ToolParametersSchema Property (Gemini Component)

The raw JSON Schema describing the tool's parameters.

Syntax

func (obj *Gemini) ToolParametersSchema(ToolIndex int32) (string, error)
func (obj *Gemini) SetToolParametersSchema(ToolIndex int32, value string) error

Default Value

""

Remarks

The raw JSON Schema describing the tool's parameters.

This property holds the raw JSON Schema object describing the parameters the tool expects, as built from calls to AddToolParam 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 ToolCount property.

Data Type

string

TopK Property (Gemini Component)

The number of top choices the model samples from.

Syntax

func (obj *Gemini) TopK() (int32, error)
func (obj *Gemini) SetTopK(value int32) error

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

int32

TopP Property (Gemini Component)

The nucleus sampling cutoff to use for the reply.

Syntax

func (obj *Gemini) TopP() (string, error)
func (obj *Gemini) SetTopP(value string) error

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

AddContent Method (Gemini Component)

Appends an item to the Contents collection.

Syntax

func (obj *Gemini) AddContent(Role string, Text string) error

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 SystemInstruction property instead.

AddTool Method (Gemini Component)

Appends a tool to the Tools collection.

Syntax

func (obj *Gemini) AddTool(Name string, Description string) error

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 AddToolParam 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.");

AddToolParam Method (Gemini Component)

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

Syntax

func (obj *Gemini) AddToolParam(Name string, ParamType string, Description string, Required bool) error

Remarks

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

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 AddTool is called.

Config Method (Gemini Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *Gemini) Config(ConfigurationString string) (string, error)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

CreateEmbedding Method (Gemini Component)

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

Syntax

func (obj *Gemini) CreateEmbedding() error

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.

DoEvents Method (Gemini Component)

This method processes events from the internal message queue.

Syntax

func (obj *Gemini) DoEvents() error

Remarks

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

GenerateContent Method (Gemini Component)

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

Syntax

func (obj *Gemini) GenerateContent() error

Remarks

This method sends the entire Contents properties, together with SystemInstruction, Tools, SafetySettings, 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 FunctionCall 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 Component)

This method interrupts the current method.

Syntax

func (obj *Gemini) Interrupt() error

Remarks

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

ListModels Method (Gemini Component)

Retrieves the list of models available from the endpoint.

Syntax

func (obj *Gemini) ListModels() error

Remarks

This method sends a request to {ServerURL}/models. The ModelList 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 Component)

This method will reset the class.

Syntax

func (obj *Gemini) Reset() error

Remarks

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

Connected Event (Gemini Component)

Fired immediately after a connection completes (or fails).

Syntax

// GeminiConnectedEventArgs carries the Gemini Connected event's parameters.
type GeminiConnectedEventArgs struct {...}

func (args *GeminiConnectedEventArgs) StatusCode() int32
func (args *GeminiConnectedEventArgs) Description() string

// GeminiConnectedEvent defines the signature of the Gemini Connected event's handler function.
type GeminiConnectedEvent func(sender *Gemini, args *GeminiConnectedEventArgs)

func (obj *Gemini) GetOnConnectedHandler() GeminiConnectedEvent
func (obj *Gemini) SetOnConnectedHandler(handlerFunc GeminiConnectedEvent)

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (Gemini Component)

Fired to indicate changes in the connection state.

Syntax

// GeminiConnectionStatusEventArgs carries the Gemini ConnectionStatus event's parameters.
type GeminiConnectionStatusEventArgs struct {...}

func (args *GeminiConnectionStatusEventArgs) ConnectionEvent() string
func (args *GeminiConnectionStatusEventArgs) StatusCode() int32
func (args *GeminiConnectionStatusEventArgs) Description() string

// GeminiConnectionStatusEvent defines the signature of the Gemini ConnectionStatus event's handler function.
type GeminiConnectionStatusEvent func(sender *Gemini, args *GeminiConnectionStatusEventArgs)

func (obj *Gemini) GetOnConnectionStatusHandler() GeminiConnectionStatusEvent
func (obj *Gemini) SetOnConnectionStatusHandler(handlerFunc 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 ConnectionEvent parameter indicates the type of connection event. Values may include the following:

ContentDelta Event (Gemini Component)

Fires once for each incremental fragment of a streamed reply.

Syntax

// GeminiContentDeltaEventArgs carries the Gemini ContentDelta event's parameters.
type GeminiContentDeltaEventArgs struct {...}

func (args *GeminiContentDeltaEventArgs) Delta() string

// GeminiContentDeltaEvent defines the signature of the Gemini ContentDelta event's handler function.
type GeminiContentDeltaEvent func(sender *Gemini, args *GeminiContentDeltaEventArgs)

func (obj *Gemini) GetOnContentDeltaHandler() GeminiContentDeltaEvent
func (obj *Gemini) SetOnContentDeltaHandler(handlerFunc GeminiContentDeltaEvent)

Remarks

This event fires when Stream is set to True and GenerateContent 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 FunctionCall 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();

Disconnected Event (Gemini Component)

Fired when a connection is closed.

Syntax

// GeminiDisconnectedEventArgs carries the Gemini Disconnected event's parameters.
type GeminiDisconnectedEventArgs struct {...}

func (args *GeminiDisconnectedEventArgs) StatusCode() int32
func (args *GeminiDisconnectedEventArgs) Description() string

// GeminiDisconnectedEvent defines the signature of the Gemini Disconnected event's handler function.
type GeminiDisconnectedEvent func(sender *Gemini, args *GeminiDisconnectedEventArgs)

func (obj *Gemini) GetOnDisconnectedHandler() GeminiDisconnectedEvent
func (obj *Gemini) SetOnDisconnectedHandler(handlerFunc GeminiDisconnectedEvent)

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

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

Please refer to the Error Codes section for more information.

EndTransfer Event (Gemini Component)

Fired when a document finishes transferring.

Syntax

// GeminiEndTransferEventArgs carries the Gemini EndTransfer event's parameters.
type GeminiEndTransferEventArgs struct {...}

func (args *GeminiEndTransferEventArgs) Direction() int32

// GeminiEndTransferEvent defines the signature of the Gemini EndTransfer event's handler function.
type GeminiEndTransferEvent func(sender *Gemini, args *GeminiEndTransferEventArgs)

func (obj *Gemini) GetOnEndTransferHandler() GeminiEndTransferEvent
func (obj *Gemini) SetOnEndTransferHandler(handlerFunc 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.

Error Event (Gemini Component)

Fired when information is available about errors during data delivery.

Syntax

// GeminiErrorEventArgs carries the Gemini Error event's parameters.
type GeminiErrorEventArgs struct {...}

func (args *GeminiErrorEventArgs) ErrorCode() int32
func (args *GeminiErrorEventArgs) Description() string

// GeminiErrorEvent defines the signature of the Gemini Error event's handler function.
type GeminiErrorEvent func(sender *Gemini, args *GeminiErrorEventArgs)

func (obj *Gemini) GetOnErrorHandler() GeminiErrorEvent
func (obj *Gemini) SetOnErrorHandler(handlerFunc GeminiErrorEvent)

Remarks

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

The ErrorCode 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.

FunctionCall Event (Gemini Component)

Fires once for each function the model calls.

Syntax

// GeminiFunctionCallEventArgs carries the Gemini FunctionCall event's parameters.
type GeminiFunctionCallEventArgs struct {...}

func (args *GeminiFunctionCallEventArgs) Name() string
func (args *GeminiFunctionCallEventArgs) ArgsJson() string

// GeminiFunctionCallEvent defines the signature of the Gemini FunctionCall event's handler function.
type GeminiFunctionCallEvent func(sender *Gemini, args *GeminiFunctionCallEventArgs)

func (obj *Gemini) GetOnFunctionCallHandler() GeminiFunctionCallEvent
func (obj *Gemini) SetOnFunctionCallHandler(handlerFunc 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 ToolName 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 GenerateContent 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();

Header Event (Gemini Component)

Fired every time a header line comes in.

Syntax

// GeminiHeaderEventArgs carries the Gemini Header event's parameters.
type GeminiHeaderEventArgs struct {...}

func (args *GeminiHeaderEventArgs) Field() string
func (args *GeminiHeaderEventArgs) Value() string

// GeminiHeaderEvent defines the signature of the Gemini Header event's handler function.
type GeminiHeaderEvent func(sender *Gemini, args *GeminiHeaderEventArgs)

func (obj *Gemini) GetOnHeaderHandler() GeminiHeaderEvent
func (obj *Gemini) SetOnHeaderHandler(handlerFunc 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).

Log Event (Gemini Component)

Fired once for each log message.

Syntax

// GeminiLogEventArgs carries the Gemini Log event's parameters.
type GeminiLogEventArgs struct {...}

func (args *GeminiLogEventArgs) LogLevel() int32
func (args *GeminiLogEventArgs) Message() string
func (args *GeminiLogEventArgs) LogType() string

// GeminiLogEvent defines the signature of the Gemini Log event's handler function.
type GeminiLogEvent func(sender *Gemini, args *GeminiLogEventArgs)

func (obj *Gemini) GetOnLogHandler() GeminiLogEvent
func (obj *Gemini) SetOnLogHandler(handlerFunc GeminiLogEvent)

Remarks

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

LogLevel 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.

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

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

ModelList Event (Gemini Component)

Fires once for each model reported by the server.

Syntax

// GeminiModelListEventArgs carries the Gemini ModelList event's parameters.
type GeminiModelListEventArgs struct {...}

func (args *GeminiModelListEventArgs) Name() string
func (args *GeminiModelListEventArgs) DisplayName() string

// GeminiModelListEvent defines the signature of the Gemini ModelList event's handler function.
type GeminiModelListEvent func(sender *Gemini, args *GeminiModelListEventArgs)

func (obj *Gemini) GetOnModelListHandler() GeminiModelListEvent
func (obj *Gemini) SetOnModelListHandler(handlerFunc GeminiModelListEvent)

Remarks

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

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.

Redirect Event (Gemini Component)

Fired when a redirection is received from the server.

Syntax

// GeminiRedirectEventArgs carries the Gemini Redirect event's parameters.
type GeminiRedirectEventArgs struct {...}

func (args *GeminiRedirectEventArgs) Location() string
func (args *GeminiRedirectEventArgs) Accept() bool
func (args *GeminiRedirectEventArgs) SetAccept(value bool)

// GeminiRedirectEvent defines the signature of the Gemini Redirect event's handler function.
type GeminiRedirectEvent func(sender *Gemini, args *GeminiRedirectEventArgs)

func (obj *Gemini) GetOnRedirectHandler() GeminiRedirectEvent
func (obj *Gemini) SetOnRedirectHandler(handlerFunc 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 component fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (Gemini Component)

Fired for every cookie set by the server.

Syntax

// GeminiSetCookieEventArgs carries the Gemini SetCookie event's parameters.
type GeminiSetCookieEventArgs struct {...}

func (args *GeminiSetCookieEventArgs) Name() string
func (args *GeminiSetCookieEventArgs) Value() string
func (args *GeminiSetCookieEventArgs) Expires() string
func (args *GeminiSetCookieEventArgs) Domain() string
func (args *GeminiSetCookieEventArgs) Path() string
func (args *GeminiSetCookieEventArgs) Secure() bool

// GeminiSetCookieEvent defines the signature of the Gemini SetCookie event's handler function.
type GeminiSetCookieEvent func(sender *Gemini, args *GeminiSetCookieEventArgs)

func (obj *Gemini) GetOnSetCookieHandler() GeminiSetCookieEvent
func (obj *Gemini) SetOnSetCookieHandler(handlerFunc 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 (URLServer) 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 (URLPath) 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.

SSLServerAuthentication Event (Gemini Component)

Fired after the server presents its certificate to the client.

Syntax

// GeminiSSLServerAuthenticationEventArgs carries the Gemini SSLServerAuthentication event's parameters.
type GeminiSSLServerAuthenticationEventArgs struct {...}

func (args *GeminiSSLServerAuthenticationEventArgs) CertEncoded() []byte
func (args *GeminiSSLServerAuthenticationEventArgs) CertSubject() string
func (args *GeminiSSLServerAuthenticationEventArgs) CertIssuer() string
func (args *GeminiSSLServerAuthenticationEventArgs) Status() string
func (args *GeminiSSLServerAuthenticationEventArgs) Accept() bool
func (args *GeminiSSLServerAuthenticationEventArgs) SetAccept(value bool)

// GeminiSSLServerAuthenticationEvent defines the signature of the Gemini SSLServerAuthentication event's handler function.
type GeminiSSLServerAuthenticationEvent func(sender *Gemini, args *GeminiSSLServerAuthenticationEventArgs)

func (obj *Gemini) GetOnSSLServerAuthenticationHandler() GeminiSSLServerAuthenticationEvent
func (obj *Gemini) SetOnSSLServerAuthenticationHandler(handlerFunc 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.

SSLStatus Event (Gemini Component)

Fired when secure connection progress messages are available.

Syntax

// GeminiSSLStatusEventArgs carries the Gemini SSLStatus event's parameters.
type GeminiSSLStatusEventArgs struct {...}

func (args *GeminiSSLStatusEventArgs) Message() string

// GeminiSSLStatusEvent defines the signature of the Gemini SSLStatus event's handler function.
type GeminiSSLStatusEvent func(sender *Gemini, args *GeminiSSLStatusEventArgs)

func (obj *Gemini) GetOnSSLStatusHandler() GeminiSSLStatusEvent
func (obj *Gemini) SetOnSSLStatusHandler(handlerFunc GeminiSSLStatusEvent)

Remarks

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

StartTransfer Event (Gemini Component)

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

Syntax

// GeminiStartTransferEventArgs carries the Gemini StartTransfer event's parameters.
type GeminiStartTransferEventArgs struct {...}

func (args *GeminiStartTransferEventArgs) Direction() int32

// GeminiStartTransferEvent defines the signature of the Gemini StartTransfer event's handler function.
type GeminiStartTransferEvent func(sender *Gemini, args *GeminiStartTransferEventArgs)

func (obj *Gemini) GetOnStartTransferHandler() GeminiStartTransferEvent
func (obj *Gemini) SetOnStartTransferHandler(handlerFunc 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.

Status Event (Gemini Component)

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

Syntax

// GeminiStatusEventArgs carries the Gemini Status event's parameters.
type GeminiStatusEventArgs struct {...}

func (args *GeminiStatusEventArgs) HTTPVersion() string
func (args *GeminiStatusEventArgs) StatusCode() int32
func (args *GeminiStatusEventArgs) Description() string

// GeminiStatusEvent defines the signature of the Gemini Status event's handler function.
type GeminiStatusEvent func(sender *Gemini, args *GeminiStatusEventArgs)

func (obj *Gemini) GetOnStatusHandler() GeminiStatusEvent
func (obj *Gemini) SetOnStatusHandler(handlerFunc GeminiStatusEvent)

Remarks

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

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

Transfer Event (Gemini Component)

Fired while a document transfers (delivers document).

Syntax

// GeminiTransferEventArgs carries the Gemini Transfer event's parameters.
type GeminiTransferEventArgs struct {...}

func (args *GeminiTransferEventArgs) Direction() int32
func (args *GeminiTransferEventArgs) BytesTransferred() int64
func (args *GeminiTransferEventArgs) PercentDone() int32
func (args *GeminiTransferEventArgs) Text() []byte

// GeminiTransferEvent defines the signature of the Gemini Transfer event's handler function.
type GeminiTransferEvent func(sender *Gemini, args *GeminiTransferEventArgs)

func (obj *Gemini) GetOnTransferHandler() GeminiTransferEvent
func (obj *Gemini) SetOnTransferHandler(handlerFunc 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 BytesTransferred 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 Component)

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 Component)

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