EmbedTextResult

class oci.generative_ai_inference.models.EmbedTextResult(**kwargs)

Bases: object

The generated embedded result to return.

Methods

__init__(**kwargs) Initializes a new EmbedTextResult object with values from keyword arguments.

Attributes

embeddings [Required] Gets the embeddings of this EmbedTextResult.
id [Required] Gets the id of this EmbedTextResult.
inputs Gets the inputs of this EmbedTextResult.
model_id Gets the model_id of this EmbedTextResult.
model_version Gets the model_version of this EmbedTextResult.
__init__(**kwargs)

Initializes a new EmbedTextResult object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • id (str) – The value to assign to the id property of this EmbedTextResult.
  • inputs (list[str]) – The value to assign to the inputs property of this EmbedTextResult.
  • embeddings (list[list[float]]) – The value to assign to the embeddings property of this EmbedTextResult.
  • model_id (str) – The value to assign to the model_id property of this EmbedTextResult.
  • model_version (str) – The value to assign to the model_version property of this EmbedTextResult.
embeddings

[Required] Gets the embeddings of this EmbedTextResult. The embeddings corresponding to inputs.

Returns:The embeddings of this EmbedTextResult.
Return type:list[list[float]]
id

[Required] Gets the id of this EmbedTextResult. A unique identifier for the generated result.

Returns:The id of this EmbedTextResult.
Return type:str
inputs

Gets the inputs of this EmbedTextResult. The original inputs. Only present if “isEcho” is set to true.

Returns:The inputs of this EmbedTextResult.
Return type:list[str]
model_id

Gets the model_id of this EmbedTextResult. The OCID of the model used in this inference request.

Returns:The model_id of this EmbedTextResult.
Return type:str
model_version

Gets the model_version of this EmbedTextResult. The version of the model.

Returns:The model_version of this EmbedTextResult.
Return type:str