API-Level Permissions for Embeddings

This page provides access and authorization information for the OCI Generative AI text embedding resource type.

For specific permissions for this resource type, review this page. For a list of all resource types available in OCI Generative AI, see User Access to Individual Resources.

Inspect Permission

The inspect verb doesn't grant access to any API operations for this resource type.

Read Permission

The read verb doesn't grant access to any API operations for this resource type.

Use Permission

Grant user groups use permission to run the following operations:

  • POST EmbedText

Manage Permission

Grant user groups manage permission to run the following operations:

  • POST EmbedText
Note

  • The manage permission includes all actions allowed by use, read, and inspect.
  • The use permission includes all actions allowed by read and inspect.
  • The read permission includes all actions allowed by inspect.
Tip

The generative-ai-text-embedding resource type is part of generative-ai-family. If you have permission to the family, you have the same permission for this resource type. For example:
allow group <your-group-name> to manage generative-ai-family
in compartment <your-compartment-name>

1-1 Permissions for APIs

Note

We recommend using the higher-level IAM verbs, manage, use, read, and inspect, for a better user experience. For example, you might grant a user group permission to delete a resource, but if you don't also grant permission to list that resource, users might not find it.

If a use case requires access to only a specific API operation, you can use the individual permissions listed here.

generative-ai-text-embedding

Permission API Operation Operation Type Verb
GENERATIVE_AI_TEXT_EMBED EmbedText POST use

For example, the following two policies are equivalent:

allow group <your-user-group> to manage generative-ai-text-embedding
in compartment <your-compartment-name>
allow group <your-user-group> to
{GENERATIVE_AI_TEXT_EMBED}
in compartment <your-compartment-name>