embeds
Creates, updates, deletes, gets or lists an embeds resource.
Overview
| Name | embeds |
| Type | Resource |
| Id | azure.ai_inference.embeds |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
embed | exec | endpoint | extra-parameters | Return the embedding vectors for given text prompts. The method makes a REST API call to the /embeddings route on the given endpoint. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: ) |
extra-parameters | string | Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload. This sets the HTTP request header extra-parameters. Known values are: "error", "drop", and "pass-through". Default value is None. |
Lifecycle Methods
- embed
Return the embedding vectors for given text prompts. The method makes a REST API call to the /embeddings route on the given endpoint.
EXEC azure.ai_inference.embeds.embed
@endpoint='{{ endpoint }}' --required,
@extra-parameters='{{ extra-parameters }}'
;