Pinecone TypeScript SDK - v8.1.0
Github Repo
Pinecone Docs
Preparing search index...
Pinecone TypeScript SDK - v8.1.0
Namespaces
Errors
Classes
Assistant
ChatStream
Index
Inference
Pinecone
Preview
PreviewIndex
PreviewIndexes
Interfaces
AlignmentResponse
AssistantFileModel
AssistantFilesList
AssistantList
AssistantModel
AssistantOptions
BackupList
BackupModel
BackupPaginationResponse
BaseChunk
BYOC2
ByocSpec
ByocSpecResponse
ChatCompletionChoiceModel
ChatCompletionModel
ChatCompletionOptions
ChatContextOptions
ChatMessageModel
ChatModel
ChatOptions
ChoiceModel
CitationChunk
CitationModel
CollectionList
CollectionModel
ConfigureIndexRequestEmbed
ContentChunk
ContentFilterResults
ContextModel
ContextOptions
CreateAssistantOptions
CreateBackupOptions
CreateCollectionRequest
CreateIndexByocSpec
CreateIndexForModelRequest
CreateIndexFromBackupOptions
CreateIndexFromBackupResponse
CreateIndexOptions
CreateIndexPodSpec
CreateIndexRequest
CreateIndexServerlessSpec
CreateIndexSpec
CreateNamespaceOptions
CreateNamespaceRequestSchema
CreateNamespaceRequestSchemaFieldsValue
DenseEmbedding
DescribeCollectionRequest
DescribeIndexRequest
DocxReferenceModel
EmbeddingsList
EmbeddingsListUsage
EmbedOptions
EvaluatedFact
EvaluateOptions
Fact
HighlightModel
Hit
ImageModel
ImportErrorMode
ImportModel
IndexList
IndexModel
IndexModelStatus
IndexOptions
JsonReferenceModel
ListBackupsOptions
ListFilesOptions
ListImportsResponse
ListItem
ListModelsOptions
ListNamespacesOptions
ListNamespacesResponse
ListOperationsOptions
ListResponse
ListRestoreJobsOptions
MarkdownReferenceModel
MessageEndChunk
MessageModel
MessageStartChunk
MetadataSchema
MetadataSchemaFieldsValue
Metrics
ModelIndexEmbed
ModelInfo
ModelInfoList
ModelInfoSupportedParameter
ModelInfoSupportedParameterAllowedValuesInner
ModelInfoSupportedParameterDefault
MultiModalContentImageBlockModel
MultiModalContentTextBlockModel
MultiModalSnippetModel
NamespaceDescription
NamespaceDescriptionIndexedFields
OperationList
OperationModel
Pagination
PaginationResponse
PdfReferenceModel
PodBased
PodSpec
PodSpecMetadataConfig
PreviewBackupList
PreviewBackupModel
PreviewBooleanField
PreviewByocDeployment
PreviewCollectionList
PreviewCollectionModel
PreviewCreateBackupOptions
PreviewCreateCollectionOptions
PreviewCreateIndexFromBackupOptions
PreviewCreateIndexFromBackupResponse
PreviewCreateIndexOptions
PreviewCreateIndexSchema
PreviewDeleteDocumentsOptions
PreviewDenseVectorField
PreviewDocumentFetchUsage
PreviewDocumentRecord
PreviewDocumentScoringMethod
PreviewDocumentSearchMatch
PreviewDocumentSearchUsage
PreviewFetchDocumentsOptions
PreviewFetchDocumentsResponse
PreviewFetchedDocument
PreviewFloatField
PreviewIndexList
PreviewIndexModel
PreviewIndexModelStatus
PreviewIndexSchema
PreviewIntegerField
PreviewLegacyMetadataField
PreviewListIndexBackupsOptions
PreviewListProjectBackupsOptions
PreviewListRestoreJobsOptions
PreviewManagedDeployment
PreviewPaginationResponse
PreviewPatchIndexDeploymentRequest
PreviewPatchIndexSchema
PreviewPatchSemanticTextField
PreviewPodDeployment
PreviewReadCapacityDedicatedConfig
PreviewReadCapacityDedicatedSpecResponse
PreviewReadCapacityOnDemandSpecResponse
PreviewReadCapacityStatus
PreviewResponseStringField
PreviewResponseStringFieldFullTextSearch
PreviewRestoreJobList
PreviewRestoreJobModel
PreviewScalingConfigManual
PreviewSearchDocumentsOptions
PreviewSearchDocumentsResponse
PreviewSemanticTextField
PreviewSparseValues
PreviewSparseVectorField
PreviewStringField
PreviewStringFieldFullTextSearch
PreviewStringListField
PreviewUpsertDocumentsOptions
PreviewUpsertDocumentsResponse
RankedDocument
ReadCapacityDedicatedConfig
ReadCapacityDedicatedSpec
ReadCapacityDedicatedSpecResponse
ReadCapacityOnDemandSpec
ReadCapacityOnDemandSpecResponse
ReadCapacityStatus
Reasoning
ReferenceModel
RerankOptions
RerankResult
RerankResultUsage
RestoreJobList
RestoreJobModel
ScalingConfigManual
ScoredPineconeRecord
SearchMatchTerms
SearchRecordsResponse
SearchRecordsResponseResult
SearchUsage
Serverless2
ServerlessSpec
ServerlessSpecResponse
SparseEmbedding
StartImportOptions
StartImportResponse
StreamedChatCompletionResponse
TextReferenceModel
TextSnippetModel
TokenCounts
UpdateAssistantOptions
UpdateAssistantResponse
Usage
UsageModel
Type Aliases
BackupId
ChatModelEnum
ChatModelEnum
CollectionName
ConfigureIndexOptions
ConfigureIndexRequestSpec
CreateIndexForModelEmbed
CreateIndexForModelOptions
CreateIndexReadCapacity
DedicatedNodeType
DeleteAllOptions
DeleteBackupOptions
DeleteCollectionOptions
DeleteIndexOptions
DeleteManyOptions
DeleteOneOptions
DescribeBackupOptions
DescribeCollectionOptions
DescribeIndexOptions
DescribeIndexStatsOptions
DescribeRestoreJobOptions
Embedding
FetchAPI
FetchByMetadataOptions
FetchByMetadataResponse
FetchOptions
FetchResponse
FinishReasonEnum
FinishReasonEnum
HTTPHeaders
IndexModelSpec
IndexName
IndexStatsDescription
IndexStatsNamespaceSummary
IntegratedRecord
ListOptions
MessagesModel
MultiModalContentBlocksModel
OperationUsage
PineconeConfiguration
PineconeRecord
PodType
PreviewConfigureIndexOptions
PreviewCreateIndexSchemaField
PreviewIndexDeployment
PreviewIndexDeploymentRequest
PreviewIndexSchemaField
PreviewReadCapacity
PreviewReadCapacityResponse
PreviewTypedIndexSchemaField
QueryByRecordId
QueryByVectorValues
QueryOptions
QueryResponse
QueryShared
ReadCapacity
ReadCapacityDedicatedParams
ReadCapacityOnDemandParams
ReadCapacityResponse
RecordId
RecordMetadata
RecordMetadataValue
RecordSparseValues
RecordValues
RestoreJobId
SearchRecordsOptions
SearchRecordsQuery
SearchRecordsRerank
SearchRecordsVector
SnippetModel
StreamedChatResponse
TypedReferenceModel
UpdateOptions
Uploadable
UploadFileOptions
UpsertFileOptions
UpsertOptions
UpsertRecordsOptions
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Namespaces
Errors
Classes
Assistant
Chat
Stream
Index
Inference
Pinecone
Preview
Preview
Index
Preview
Indexes
Interfaces
Alignment
Response
Assistant
File
Model
Assistant
Files
List
Assistant
List
Assistant
Model
Assistant
Options
Backup
List
Backup
Model
Backup
Pagination
Response
Base
Chunk
BYOC2
Byoc
Spec
Byoc
Spec
Response
Chat
Completion
Choice
Model
Chat
Completion
Model
Chat
Completion
Options
Chat
Context
Options
Chat
Message
Model
Chat
Model
Chat
Options
Choice
Model
Citation
Chunk
Citation
Model
Collection
List
Collection
Model
Configure
Index
Request
Embed
Content
Chunk
Content
Filter
Results
Context
Model
Context
Options
Create
Assistant
Options
Create
Backup
Options
Create
Collection
Request
Create
Index
Byoc
Spec
Create
Index
For
Model
Request
Create
Index
From
Backup
Options
Create
Index
From
Backup
Response
Create
Index
Options
Create
Index
Pod
Spec
Create
Index
Request
Create
Index
Serverless
Spec
Create
Index
Spec
Create
Namespace
Options
Create
Namespace
Request
Schema
Create
Namespace
Request
Schema
Fields
Value
Dense
Embedding
Describe
Collection
Request
Describe
Index
Request
Docx
Reference
Model
Embeddings
List
Embeddings
List
Usage
Embed
Options
Evaluated
Fact
Evaluate
Options
Fact
Highlight
Model
Hit
Image
Model
Import
Error
Mode
Import
Model
Index
List
Index
Model
Index
Model
Status
Index
Options
Json
Reference
Model
List
Backups
Options
List
Files
Options
List
Imports
Response
List
Item
List
Models
Options
List
Namespaces
Options
List
Namespaces
Response
List
Operations
Options
List
Response
List
Restore
Jobs
Options
Markdown
Reference
Model
Message
End
Chunk
Message
Model
Message
Start
Chunk
Metadata
Schema
Metadata
Schema
Fields
Value
Metrics
Model
Index
Embed
Model
Info
Model
Info
List
Model
Info
Supported
Parameter
Model
Info
Supported
Parameter
Allowed
Values
Inner
Model
Info
Supported
Parameter
Default
Multi
Modal
Content
Image
Block
Model
Multi
Modal
Content
Text
Block
Model
Multi
Modal
Snippet
Model
Namespace
Description
Namespace
Description
Indexed
Fields
Operation
List
Operation
Model
Pagination
Pagination
Response
Pdf
Reference
Model
Pod
Based
Pod
Spec
Pod
Spec
Metadata
Config
Preview
Backup
List
Preview
Backup
Model
Preview
Boolean
Field
Preview
Byoc
Deployment
Preview
Collection
List
Preview
Collection
Model
Preview
Create
Backup
Options
Preview
Create
Collection
Options
Preview
Create
Index
From
Backup
Options
Preview
Create
Index
From
Backup
Response
Preview
Create
Index
Options
Preview
Create
Index
Schema
Preview
Delete
Documents
Options
Preview
Dense
Vector
Field
Preview
Document
Fetch
Usage
Preview
Document
Record
Preview
Document
Scoring
Method
Preview
Document
Search
Match
Preview
Document
Search
Usage
Preview
Fetch
Documents
Options
Preview
Fetch
Documents
Response
Preview
Fetched
Document
Preview
Float
Field
Preview
Index
List
Preview
Index
Model
Preview
Index
Model
Status
Preview
Index
Schema
Preview
Integer
Field
Preview
Legacy
Metadata
Field
Preview
List
Index
Backups
Options
Preview
List
Project
Backups
Options
Preview
List
Restore
Jobs
Options
Preview
Managed
Deployment
Preview
Pagination
Response
Preview
Patch
Index
Deployment
Request
Preview
Patch
Index
Schema
Preview
Patch
Semantic
Text
Field
Preview
Pod
Deployment
Preview
Read
Capacity
Dedicated
Config
Preview
Read
Capacity
Dedicated
Spec
Response
Preview
Read
Capacity
On
Demand
Spec
Response
Preview
Read
Capacity
Status
Preview
Response
String
Field
Preview
Response
String
Field
Full
Text
Search
Preview
Restore
Job
List
Preview
Restore
Job
Model
Preview
Scaling
Config
Manual
Preview
Search
Documents
Options
Preview
Search
Documents
Response
Preview
Semantic
Text
Field
Preview
Sparse
Values
Preview
Sparse
Vector
Field
Preview
String
Field
Preview
String
Field
Full
Text
Search
Preview
String
List
Field
Preview
Upsert
Documents
Options
Preview
Upsert
Documents
Response
Ranked
Document
Read
Capacity
Dedicated
Config
Read
Capacity
Dedicated
Spec
Read
Capacity
Dedicated
Spec
Response
Read
Capacity
On
Demand
Spec
Read
Capacity
On
Demand
Spec
Response
Read
Capacity
Status
Reasoning
Reference
Model
Rerank
Options
Rerank
Result
Rerank
Result
Usage
Restore
Job
List
Restore
Job
Model
Scaling
Config
Manual
Scored
Pinecone
Record
Search
Match
Terms
Search
Records
Response
Search
Records
Response
Result
Search
Usage
Serverless2
Serverless
Spec
Serverless
Spec
Response
Sparse
Embedding
Start
Import
Options
Start
Import
Response
Streamed
Chat
Completion
Response
Text
Reference
Model
Text
Snippet
Model
Token
Counts
Update
Assistant
Options
Update
Assistant
Response
Usage
Usage
Model
Type Aliases
Backup
Id
Chat
Model
Enum
Chat
Model
Enum
Collection
Name
Configure
Index
Options
Configure
Index
Request
Spec
Create
Index
For
Model
Embed
Create
Index
For
Model
Options
Create
Index
Read
Capacity
Dedicated
Node
Type
Delete
All
Options
Delete
Backup
Options
Delete
Collection
Options
Delete
Index
Options
Delete
Many
Options
Delete
One
Options
Describe
Backup
Options
Describe
Collection
Options
Describe
Index
Options
Describe
Index
Stats
Options
Describe
Restore
Job
Options
Embedding
Fetch
API
Fetch
By
Metadata
Options
Fetch
By
Metadata
Response
Fetch
Options
Fetch
Response
Finish
Reason
Enum
Finish
Reason
Enum
HTTP
Headers
Index
Model
Spec
Index
Name
Index
Stats
Description
Index
Stats
Namespace
Summary
Integrated
Record
List
Options
Messages
Model
Multi
Modal
Content
Blocks
Model
Operation
Usage
Pinecone
Configuration
Pinecone
Record
Pod
Type
Preview
Configure
Index
Options
Preview
Create
Index
Schema
Field
Preview
Index
Deployment
Preview
Index
Deployment
Request
Preview
Index
Schema
Field
Preview
Read
Capacity
Preview
Read
Capacity
Response
Preview
Typed
Index
Schema
Field
Query
By
Record
Id
Query
By
Vector
Values
Query
Options
Query
Response
Query
Shared
Read
Capacity
Read
Capacity
Dedicated
Params
Read
Capacity
On
Demand
Params
Read
Capacity
Response
Record
Id
Record
Metadata
Record
Metadata
Value
Record
Sparse
Values
Record
Values
Restore
Job
Id
Search
Records
Options
Search
Records
Query
Search
Records
Rerank
Search
Records
Vector
Snippet
Model
Streamed
Chat
Response
Typed
Reference
Model
Update
Options
Uploadable
Upload
File
Options
Upsert
File
Options
Upsert
Options
Upsert
Records
Options
Github Repo
Pinecone Docs
Pinecone TypeScript SDK - v8.1.0
Loading...