EmbeddingConfig¶

class oci.generative_ai.models.EmbeddingConfig(**kwargs)¶

Bases: ModelConfig

Configuration for generating embeddings from extracted information.

Attributes:

`MODEL_CONFIG_TYPE_CONDENSER`	A constant which can be used with the model_config_type property of a ModelConfig.
`MODEL_CONFIG_TYPE_EMBEDDING`	A constant which can be used with the model_config_type property of a ModelConfig.
`MODEL_CONFIG_TYPE_EXTRACTION`	A constant which can be used with the model_config_type property of a ModelConfig.
`llm_selection`	[Required] Gets the llm_selection of this ModelConfig.
`model_config_type`	[Required] Gets the model_config_type of this ModelConfig.

Methods:

`__init__`(**kwargs)	Initializes a new EmbeddingConfig 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.

MODEL_CONFIG_TYPE_CONDENSER = 'CONDENSER'¶: A constant which can be used with the model_config_type property of a ModelConfig. This constant has a value of “CONDENSER”

MODEL_CONFIG_TYPE_EMBEDDING = 'EMBEDDING'¶: A constant which can be used with the model_config_type property of a ModelConfig. This constant has a value of “EMBEDDING”

MODEL_CONFIG_TYPE_EXTRACTION = 'EXTRACTION'¶: A constant which can be used with the model_config_type property of a ModelConfig. This constant has a value of “EXTRACTION”

__init__(**kwargs)¶

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

Parameters

model_config_type (str) – The value to assign to the model_config_type property of this EmbeddingConfig. Allowed values for this property are: “EXTRACTION”, “EMBEDDING”, “CONDENSER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
llm_selection (oci.generative_ai.models.LlmSelection) – The value to assign to the llm_selection property of this EmbeddingConfig.

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.

property llm_selection¶

[Required] Gets the llm_selection of this ModelConfig.

Returns: The llm_selection of this ModelConfig.
Return type: oci.generative_ai.models.LlmSelection

property model_config_type¶

[Required] Gets the model_config_type of this ModelConfig. The stage-specific config type.

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

Returns: The model_config_type of this ModelConfig.
Return type: str