| external help file | Module Name | online version | schema |
|---|---|---|---|
PSOpenAI-help.xml |
PSOpenAI |
2.0.0 |
Create a vector store.
New-VectorStore
[-Name <String>]
[-FileId <Object[]>]
[-ExpiresAfterDays <UInt16>]
[-ExpiresAfterAnchor <String>]
[-ChunkingStrategy <String>]
[-MaxChunkSizeTokens <Int32>]
[-ChunkOverlapTokens <Int32>]
[-MetaData <IDictionary>]
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Create a vector store.
PS C:\> New-VectorStore -Name "Test-Store-X"Creates a new vector store that the name has.
PS C:\> New-VectorStore -Name "Test-Store-X" -FileId ('file-abc123', 'file-def456', 'file-ghi789')Creates a new vector store with attached 3 files.
The name of the vector store.
Type: String
Required: False
Position: NamedA list of File IDs that the vector store should use.
Type: Object[]
Aliases: file_ids
Required: False
Position: NamedThe number of days after the anchor time that the vector store will expire.
Type: UInt16
Required: False
Position: NamedAnchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.
Type: String
Required: False
Position: Named
Default value: last_active_atThe chunking strategy used to chunk the file(s). If not set, will use the "auto" strategy. Only applicable if FileId is non-empty.
Type: String
Aliases: chunking_strategy
Required: False
Position: NamedThe maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.
Note that the parameter only acceptable when the ChunkingStrategy is "static".
Type: String
Aliases: max_chunk_size_tokens
Required: False
Position: Named
Default value: 800The number of tokens that overlap between chunks. The default value is 400. The value must not exceed half of MaxChunkSizeTokens.
Note that the parameter only acceptable when the ChunkingStrategy is "static".
Type: String
Aliases: chunk_overlap_tokens
Required: False
Position: Named
Default value: 400Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format.
Type: IDictionary
Required: False
Position: NamedSpecifies how long the request can be pending before it times out.
The default value is 0 (infinite).
Type: Int32
Required: False
Position: Named
Default value: 0Number between 0 and 100.
Specifies the maximum number of retries if the request fails.
The default value is 0 (No retry).
Note : Retries will only be performed if the request fails with a 429 (Rate limit reached) or 5xx (Server side errors) error. Other errors (e.g., authentication failure) will not be performed.
Type: Int32
Required: False
Position: Named
Default value: 0Specifies an API endpoint URL such like: https://your-api-endpoint.test/v1
If not specified, it will use https://api.openai.com/v1
Type: System.Uri
Required: False
Position: Named
Default value: https://api.openai.com/v1Specifies API key for authentication.
The type of data should [string] or [securestring].
If not specified, it will try to use $global:OPENAI_API_KEY or $env:OPENAI_API_KEY
Type: Object
Required: False
Position: NamedSpecifies Organization ID which used for an API request.
If not specified, it will try to use $global:OPENAI_ORGANIZATION or $env:OPENAI_ORGANIZATION
Type: string
Aliases: OrgId
Required: False
Position: Namedhttps://platform.openai.com/docs/api-reference/vector-stores/create