OnYourDataEndpointVectorizationSource interface

  • Reference
Package:
@azure/openai

The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on a public Azure OpenAI endpoint call for embeddings.

Extends
OnYourDataVectorizationSource

Properties

authentication

Specifies the authentication options to use when retrieving embeddings from the specified endpoint.
endpoint

Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed.
type

The type of vectorization source to use. Always 'Endpoint' for this type.

Property Details

authentication

Specifies the authentication options to use when retrieving embeddings from the specified endpoint.

authentication: OnYourDataAuthenticationOptionsUnion

Property Value

OnYourDataAuthenticationOptionsUnion

endpoint

Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed.

endpoint: string

Property Value

string

type

The type of vectorization source to use. Always 'Endpoint' for this type.

type: "endpoint"

Property Value

"endpoint"