ApiKeyAiModelAuthDetails

class oci.golden_gate.models.ApiKeyAiModelAuthDetails(**kwargs)

Bases: AiModelAuthDetails

API key authentication details for an AI Model connection.

Attributes:

AUTH_TYPE_API_KEY

A constant which can be used with the auth_type property of a AiModelAuthDetails.

AUTH_TYPE_OCI_GEN_AI

A constant which can be used with the auth_type property of a AiModelAuthDetails.

api_key

Gets the api_key of this ApiKeyAiModelAuthDetails.

api_key_secret_id

Gets the api_key_secret_id of this ApiKeyAiModelAuthDetails.

auth_type

[Required] Gets the auth_type of this AiModelAuthDetails.

base_url

Gets the base_url of this ApiKeyAiModelAuthDetails.

Methods:

__init__(**kwargs)

Initializes a new ApiKeyAiModelAuthDetails object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

AUTH_TYPE_API_KEY = 'API_KEY'

A constant which can be used with the auth_type property of a AiModelAuthDetails. This constant has a value of “API_KEY”

AUTH_TYPE_OCI_GEN_AI = 'OCI_GEN_AI'

A constant which can be used with the auth_type property of a AiModelAuthDetails. This constant has a value of “OCI_GEN_AI”

__init__(**kwargs)

Initializes a new ApiKeyAiModelAuthDetails object with values from keyword arguments. The default value of the auth_type attribute of this class is API_KEY and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • auth_type (str) – The value to assign to the auth_type property of this ApiKeyAiModelAuthDetails. Allowed values for this property are: “OCI_GEN_AI”, “API_KEY”

  • base_url (str) – The value to assign to the base_url property of this ApiKeyAiModelAuthDetails.

  • api_key (str) – The value to assign to the api_key property of this ApiKeyAiModelAuthDetails.

  • api_key_secret_id (str) – The value to assign to the api_key_secret_id property of this ApiKeyAiModelAuthDetails.

property api_key

Gets the api_key of this ApiKeyAiModelAuthDetails. API key for the AI model connection. Deprecated: This field is deprecated and replaced by “apiKeySecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns

The api_key of this ApiKeyAiModelAuthDetails.

Return type

str

property api_key_secret_id

Gets the api_key_secret_id of this ApiKeyAiModelAuthDetails. API key secret OCID for the AI model connection.

Returns

The api_key_secret_id of this ApiKeyAiModelAuthDetails.

Return type

str

property auth_type

[Required] Gets the auth_type of this AiModelAuthDetails. Authentication type used by the AI model connection.

Allowed values for this property are: “OCI_GEN_AI”, “API_KEY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The auth_type of this AiModelAuthDetails.

Return type

str

property base_url

Gets the base_url of this ApiKeyAiModelAuthDetails. Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.

Returns

The base_url of this ApiKeyAiModelAuthDetails.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.