Edit

Share via


New-AzCosmosDBSqlVectorIndex

Creates a new CosmosDB Sql VectorIndex object.

Syntax

New-AzCosmosDBSqlVectorIndex
   [-Path <String>]
   [-Type <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzCosmosDBSqlVectorIndex cmdlet creates a new object of type PSSqlVectorIndex.

Examples

Example 1

New-AzCosmosDBSqlVectorIndex -Path "/vector1" -Type "flat"

Path Type
---- ----
/vector1   flat

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

The path to the vector field in the document.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Type

The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

PSSqlVectorIndex