Github Repo
Pinecone Docs
Preparing search index...
The search index is not available
Pinecone TypeScript SDK - v6.0.0
Pinecone TypeScript SDK
DescribeBackupOptions
Type alias DescribeBackupOptions
Describe
Backup
Options
:
BackupId
The string ID of the backup to describe.
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Pinecone
Type
Script SDK -
v6.0.0
Errors
Assistant
Chat
Stream
Index
Inference
Pinecone
Assistant
File
Model
Assistant
Files
List
Assistant
List
Assistant
Model
Backup
List
Backup
Model
Base
Chunk
Chat
Completion
Model
Chat
Completion
Options
Chat
Model
Chat
Options
Choice
Model
Citation
Chunk
Citation
Model
Collection
List
Collection
Model
Configure
Index
Request
Spec
Pod
Content
Chunk
Context
Model
Context
Options
Create
Assistant
Options
Create
Backup
Options
Create
Collection
Request
Create
Index
For
Model
Request
Create
Index
From
Backup
Options
Create
Index
From
Backup
Response
Create
Index
Options
Create
Index
Request
Describe
Collection
Request
Describe
Index
Request
Embeddings
List
Embeddings
List
Usage
Highlight
Model
Import
Model
Index
List
Index
Model
List
Backups
Options
List
Files
Options
List
Models
Options
List
Namespaces
Response
List
Response
List
Restore
Jobs
Options
Message
End
Chunk
Message
Model
Message
Start
Chunk
Model
Info
Model
Info
List
Namespace
Description
Pod
Spec
Pod
Spec
Metadata
Config
Ranked
Document
Rerank
Options
Rerank
Result
Rerank
Result
Usage
Restore
Job
List
Restore
Job
Model
Scored
Pinecone
Record
Search
Records
Response
Search
Records
Response
Result
Search
Usage
Serverless
Spec
Start
Import
Response
Streamed
Chat
Completion
Response
Update
Assistant
Options
Update
Assistant
Response
Upload
File
Options
Usage
Model
Assistant
File
Status
Enum
Assistant
Status
Enum
Backup
Id
Chat
Model
Enum
Chat
Model
Finish
Reason
Enum
Collection
Name
Create
Index
Request
Metric
Enum
Delete
Backup
Options
Delete
Collection
Options
Delete
Index
Options
Delete
Many
By
Filter
Options
Delete
Many
By
Record
Id
Options
Delete
Many
Options
Delete
One
Options
Deletion
Protection
Describe
Backup
Options
Describe
Collection
Options
Describe
Index
Options
Describe
Index
Stats
Options
Describe
Restore
Job
Options
Embedding
FetchAPI
Fetch
Options
Fetch
Response
Finish
Reason
Enum
Index
Model
Metric
Enum
Index
Name
Index
Stats
Description
Index
Stats
Namespace
Summary
Integrated
Record
Pinecone
Configuration
Pinecone
Record
Pod
Type
Query
By
Record
Id
Query
By
Vector
Values
Query
Options
Query
Response
Query
Shared
Record
Id
Record
Metadata
Record
Metadata
Value
Record
Sparse
Values
Record
Values
Restore
Job
Id
Serverless
Spec
Cloud
Enum
Streamed
Chat
Response
Update
Options
Assistant
File
Status
Enum
Assistant
Status
Enum
Chat
Model
Enum
Chat
Model
Finish
Reason
Enum
Create
Index
Request
Metric
Enum
Deletion
Protection
Finish
Reason
Enum
Index
Model
Metric
Enum
Serverless
Spec
Cloud
Enum
The string ID of the backup to describe.