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:

`embed_contents`	Gets the embed_contents of this EmbedTextResult.
`embeddings`	[Required] Gets the embeddings of this EmbedTextResult.
`embeddings_by_type`	Gets the embeddings_by_type 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.
`usage`	Gets the usage 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.
embed_contents (list[oci.generative_ai_inference.models.EmbedContent]) – The value to assign to the embed_contents property of this EmbedTextResult.
embeddings (list[list[float]]) – The value to assign to the embeddings property of this EmbedTextResult.
embeddings_by_type (object) – The value to assign to the embeddings_by_type 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.
usage (oci.generative_ai_inference.models.Usage) – The value to assign to the usage property of this EmbedTextResult.

property embed_contents¶

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

Returns: The embed_contents of this EmbedTextResult.
Return type: list[oci.generative_ai_inference.models.EmbedContent]

property embeddings¶

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

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

property embeddings_by_type¶

Gets the embeddings_by_type of this EmbedTextResult. The embeddings corresponding to embedding types input.

Returns: The embeddings_by_type of this EmbedTextResult.
Return type: object

property id¶

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

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

property 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]

property 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

property model_version¶

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

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

property usage¶

Gets the usage of this EmbedTextResult.

Returns: The usage of this EmbedTextResult.
Return type: oci.generative_ai_inference.models.Usage