google.generativeai.protos.EmbedContentRequest
Request containing the Content for the model to embed.
Attributes |
|---|
|
`model`
|
`str`
Required. The model's resource name. This serves as an ID
for the Model to use.
This name should match a model name returned by the
``ListModels`` method.
Format: ``models/{model}``
|
|
`content`
|
`google.ai.generativelanguage.Content`
Required. The content to embed. Only the ``parts.text``
fields will be counted.
|
|
`task_type`
|
`google.ai.generativelanguage.TaskType`
Optional. Optional task type for which the embeddings will
be used. Can only be set for ``models/embedding-001``.
|
|
`title`
|
`str`
Optional. An optional title for the text. Only applicable
when TaskType is ``RETRIEVAL_DOCUMENT``.
Note: Specifying a ``title`` for ``RETRIEVAL_DOCUMENT``
provides better quality embeddings for retrieval.
|
|
`output_dimensionality`
|
`int`
Optional. Optional reduced dimension for the output
embedding. If set, excessive values in the output embedding
are truncated from the end. Supported by newer models since
2024 only. You cannot set this value if using the earlier
model (``models/embedding-001``).
|
View source on GitHub