GetEmbeddingsOptions interface
Options for to custom embeddings request
- Extends
Properties
dimensions | The number of dimensions the resulting output embeddings should have. Only supported in |
model | The model name to provide as part of this embeddings request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to. |
user | An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. |
Inherited Properties
abort |
The signal which can be used to abort requests. |
on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
request |
Options used when creating and sending HTTP requests for this operation. |
tracing |
Options used when tracing is enabled. |
Property Details
dimensions
The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3
and later models.
dimensions?: number
Property Value
number
model
The model name to provide as part of this embeddings request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to.
model?: string
Property Value
string
user
An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes.
user?: string
Property Value
string
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From OperationOptions.abortSignal
onResponse
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
onResponse?: RawResponseCallback
Property Value
Inherited From OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptions
Property Value
Inherited From OperationOptions.requestOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From OperationOptions.tracingOptions
Azure SDK for JavaScript