Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

      Pinecone TypeScript SDK - v9.0.0

      README
      faq
      assistant/chat
      assistant/file-management
      assistant/getting-started
      data-operations/bulk-import
      data-operations/metadata-filtering
      data-operations/namespaces
      data-operations/working-with-documents
      data-operations/working-with-vectors
      index-management/backup-schedules
      index-management/backups
      index-management/collections
      index-management/pod-indexes
      index-management/serverless-indexes
      index-management/shared-operations
      inference/inference-api
      inference/integrated-inference
      typescript-features/async-patterns
      typescript-features/error-handling
      typescript-features/type-safety
      upgrading/v1-migration
      upgrading/v2-migration
      upgrading/v8-migration
      upgrading/v9-migration
      Errors
      AdminClient
      ApiKeysResource
      Assistant
      Assistants
      Backups
      BackupSchedules
      ChatStream
      Collections
      Documents
      Index
      Indexes
      Inference
      InvitesResource
      OrganizationsResource
      Pinecone
      PineconeIndexPropertyError
      ProjectsResource
      RestoreJobs
      RoleBindingsResource
      ServiceAccountsResource
      UsersResource
      AdminErrorResponse
      AdminErrorResponseError
      AlignmentResponse
      APIKey
      APIKeyWithSecret
      AssistantFileModel
      AssistantFilesList
      AssistantList
      AssistantModel
      AssistantOptions
      BackupList
      BackupListPagination
      BackupModel
      BackupScheduleHistoryItem
      BackupScheduleHistoryList
      BackupScheduleList
      BackupScheduleModel
      BaseChunk
      BatchUpsertDocumentsError
      BatchUpsertDocumentsOptions
      BatchUpsertDocumentsResponse
      BooleanField
      ByocDeployment
      ChatCompletionChoiceModel
      ChatCompletionModel
      ChatCompletionOptions
      ChatContextOptions
      ChatMessageModel
      ChatModel
      ChatOptions
      ChoiceModel
      CitationChunk
      CitationModel
      CollectionList
      CollectionModel
      ConfigureIndexRequest
      ContentChunk
      ContentFilterResults
      ContextModel
      ContextOptions
      CreateAssistantOptions
      CreateBackupOptions
      CreateBackupScheduleOptions
      CreateCollectionOptions
      CreateCollectionRequest
      CreateIndexByocSpec
      CreateIndexForModelEmbed
      CreateIndexForModelOptions
      CreateIndexForModelRequest
      CreateIndexFromBackupOptions
      CreateIndexFromBackupResponse
      CreateIndexPodSpec
      CreateIndexRequest
      CreateIndexSchema
      CreateIndexServerlessSpec
      CreateNamespaceOptions
      CreateNamespaceRequestSchema
      CreateNamespaceRequestSchemaFieldsValue
      DeleteDocumentsOptions
      DeleteDocumentsResponse
      DenseEmbedding
      DenseVectorField
      DerivedLegacyIndexSpec
      DeriveFailure
      DescribeCollectionRequest
      DescribeIndexRequest
      DocumentFetchUsage
      DocumentListUsage
      DocumentRecord
      DocumentScoringMethod
      DocumentSearchMatch
      DocumentSearchUsage
      DocxReferenceModel
      EmbeddingsList
      EmbeddingsListUsage
      EmbedOptions
      EvaluatedFact
      EvaluateOptions
      Fact
      FetchDocumentsOptions
      FetchDocumentsResponse
      FetchedDocument
      FloatField
      HighlightModel
      Hit
      ImageModel
      ImportErrorMode
      ImportModel
      IndexList
      IndexModel
      IndexModelData
      IndexModelStatus
      IndexOptions
      IndexSchema
      IntegerField
      Invite
      InviteList
      InviteListPagination
      JsonReferenceModel
      LegacyByocSpec
      LegacyCreateIndexOptions
      LegacyCreateIndexSpec
      LegacyIndexEmbed
      LegacyIndexProperties
      LegacyMetadataField
      LegacyPodSpec
      LegacyServerlessSpec
      ListApiKeysResponse
      ListBackupSchedulesOptions
      ListBackupsOptions
      ListDocumentsOptions
      ListDocumentsResponse
      ListedDocumentRecord
      ListFilesOptions
      ListImportsResponse
      ListIndexBackupsOptions
      ListItem
      ListModelsOptions
      ListNamespacesOptions
      ListNamespacesResponse
      ListOperationsOptions
      ListProjectBackupsOptions
      ListResponse
      ListRestoreJobsOptions
      ManagedDeployment
      MarkdownReferenceModel
      MessageEndChunk
      MessageModel
      MessageStartChunk
      Metrics
      ModelInfo
      ModelInfoList
      ModelInfoSupportedParameter
      ModelInfoSupportedParameterAllowedValuesInner
      ModelInfoSupportedParameterDefault
      MultiModalContentImageBlockModel
      MultiModalContentTextBlockModel
      MultiModalSnippetModel
      NamespaceDescription
      NamespaceDescriptionIndexedFields
      NativeCreateIndexOptions
      OperationList
      OperationModel
      Organization
      OrganizationList
      Pagination
      PaginationResponse
      PatchIndexDeploymentRequest
      PatchIndexSchema
      PatchSemanticTextField
      PdfReferenceModel
      PodDeployment
      Project
      ProjectList
      RankedDocument
      ReadCapacityDedicated
      ReadCapacityDedicatedConfig
      ReadCapacityDedicatedSettings
      ReadCapacityDedicatedSpecResponse
      ReadCapacityOnDemand
      ReadCapacityOnDemandSpecResponse
      ReadCapacityStatus
      Reasoning
      ReferenceModel
      RerankOptions
      RerankResult
      RerankResultUsage
      ResponseStringField
      ResponseStringFieldFullTextSearch
      ResponseStringFieldFullTextSearchNgram
      RestoreJobList
      RestoreJobModel
      RoleBinding
      RoleBindingInput
      RoleBindingList
      ScalingConfigManual
      ScalingConfigManualInput
      ScoredPineconeRecord
      SearchDocumentsOptions
      SearchDocumentsResponse
      SearchMatchTerms
      SearchRecordsResponse
      SearchRecordsResponseResult
      SearchUsage
      SemanticTextField
      ServiceAccount
      ServiceAccountList
      ServiceAccountWithSecret
      SparseEmbedding
      SparseValues
      SparseVectorField
      StartImportOptions
      StartImportResponse
      StreamedChatCompletionResponse
      StringField
      StringFieldFullTextSearch
      StringFieldFullTextSearchNgram
      StringListField
      TextReferenceModel
      TextSnippetModel
      TokenCounts
      UpdateAssistantOptions
      UpdateAssistantResponse
      UpdateBackupScheduleOptions
      UpdateDocumentRecord
      UpdateDocumentsOptions
      UpdateDocumentsResponse
      UpsertDocumentsOptions
      UpsertDocumentsResponse
      Usage
      UsageModel
      User
      UserList
      AdminClientConfiguration
      BackupId
      BackupScheduleFrequency
      BackupScheduleId
      BackupStatus
      BatchUpsertDisposition
      BatchUpsertErrorMode
      ByocSpecResponse
      ChatModelEnum
      ChatModelEnum
      CollectionName
      CollectionStatus
      ConfigureIndexOptions
      ConfigureIndexResourceOptions
      CreateApiKeyOptions
      CreateBackupResourceOptions
      CreateIndexFromBackupResourceOptions
      CreateIndexOptions
      CreateIndexReadCapacity
      CreateIndexSchemaField
      CreateIndexSpec
      CreateInviteOptions
      CreateProjectOptions
      CreateRoleBindingOptions
      CreateServiceAccountOptions
      DedicatedNodeType
      DeleteAllOptions
      DeleteBackupOptions
      DeleteCollectionOptions
      DeleteIndexOptions
      DeleteManyOptions
      DeleteOneOptions
      DeletionProtection
      Derived
      DeriveFailureReason
      DescribeBackupOptions
      DescribeCollectionOptions
      DescribeIndexOptions
      DescribeIndexStatsOptions
      DescribeRestoreJobOptions
      Embedding
      FetchAPI
      FetchByMetadataOptions
      FetchByMetadataResponse
      FetchOptions
      FetchResponse
      FinishReasonEnum
      FinishReasonEnum
      FullTextSearchStringField
      HTTPHeaders
      IndexDeployment
      IndexDeploymentRequest
      IndexMetric
      IndexModelSpec
      IndexName
      IndexSchemaField
      IndexShape
      IndexState
      IndexStatsDescription
      IndexStatsNamespaceSummary
      IntegratedRecord
      LegacyConfigureIndexOptions
      LegacyIndexSpec
      ListInvitesOptions
      ListOptions
      ListRoleBindingsOptions
      ListServiceAccountsOptions
      ListUsersOptions
      MessagesModel
      ModelIndexEmbed
      MultiModalContentBlocksModel
      NativeConfigureIndexOptions
      OperationUsage
      PineconeConfiguration
      PineconeRecord
      PodSpec
      PodType
      QueryByRecordId
      QueryByVectorValues
      QueryOptions
      QueryResponse
      QueryShared
      ReadCapacity
      ReadCapacityDedicatedParams
      ReadCapacityOnDemandParams
      ReadCapacityResponse
      ReadCapacityScaling
      ReadCapacityState
      RecordId
      RecordMetadata
      RecordMetadataValue
      RecordSparseValues
      RecordValues
      RestoreJobId
      ScheduledBackupStatus
      SearchRecordsOptions
      SearchRecordsQuery
      SearchRecordsRerank
      SearchRecordsVector
      ServerlessSpecResponse
      SnippetModel
      StreamedChatResponse
      TypedIndexSchemaField
      TypedReferenceModel
      UpdateApiKeyOptions
      UpdateOptions
      UpdateOrganizationOptions
      UpdateProjectOptions
      UpdateServiceAccountOptions
      Uploadable
      UploadFileOptions
      UpsertFileOptions
      UpsertOptions
      UpsertRecordsOptions
      classifyIndexShape
      deriveDimension
      deriveEmbed
      deriveMetric
      deriveSpec
      deriveVectorType
      DocumentPagination → Pagination

      Settings
      Member Visibility

      On This Page
      Documents
      Namespaces
      Classes
      Interfaces
      AdminErrorResponseAdminErrorResponseErrorAlignmentResponseAPIKeyAPIKeyWithSecretAssistantFileModelAssistantFilesListAssistantListAssistantModelAssistantOptionsBackupListBackupListPaginationBackupModelBackupScheduleHistoryItemBackupScheduleHistoryListBackupScheduleListBackupScheduleModelBaseChunkBatchUpsertDocumentsErrorBatchUpsertDocumentsOptionsBatchUpsertDocumentsResponseBooleanFieldByocDeploymentChatCompletionChoiceModelChatCompletionModelChatCompletionOptionsChatContextOptionsChatMessageModelChatModelChatOptionsChoiceModelCitationChunkCitationModelCollectionListCollectionModelConfigureIndexRequestContentChunkContentFilterResultsContextModelContextOptionsCreateAssistantOptionsCreateBackupOptionsCreateBackupScheduleOptionsCreateCollectionOptionsCreateCollectionRequestCreateIndexByocSpecCreateIndexForModelEmbedCreateIndexForModelOptionsCreateIndexForModelRequestCreateIndexFromBackupOptionsCreateIndexFromBackupResponseCreateIndexPodSpecCreateIndexRequestCreateIndexSchemaCreateIndexServerlessSpecCreateNamespaceOptionsCreateNamespaceRequestSchemaCreateNamespaceRequestSchemaFieldsValueDeleteDocumentsOptionsDeleteDocumentsResponseDenseEmbeddingDenseVectorFieldDerivedLegacyIndexSpecDeriveFailureDescribeCollectionRequestDescribeIndexRequestDocumentFetchUsageDocumentListUsageDocumentRecordDocumentScoringMethodDocumentSearchMatchDocumentSearchUsageDocxReferenceModelEmbeddingsListEmbeddingsListUsageEmbedOptionsEvaluatedFactEvaluateOptionsFactFetchDocumentsOptionsFetchDocumentsResponseFetchedDocumentFloatFieldHighlightModelHitImageModelImportErrorModeImportModelIndexListIndexModelIndexModelDataIndexModelStatusIndexOptionsIndexSchemaIntegerFieldInviteInviteListInviteListPaginationJsonReferenceModelLegacyByocSpecLegacyCreateIndexOptionsLegacyCreateIndexSpecLegacyIndexEmbedLegacyIndexPropertiesLegacyMetadataFieldLegacyPodSpecLegacyServerlessSpecListApiKeysResponseListBackupSchedulesOptionsListBackupsOptionsListDocumentsOptionsListDocumentsResponseListedDocumentRecordListFilesOptionsListImportsResponseListIndexBackupsOptionsListItemListModelsOptionsListNamespacesOptionsListNamespacesResponseListOperationsOptionsListProjectBackupsOptionsListResponseListRestoreJobsOptionsManagedDeploymentMarkdownReferenceModelMessageEndChunkMessageModelMessageStartChunkMetricsModelInfoModelInfoListModelInfoSupportedParameterModelInfoSupportedParameterAllowedValuesInnerModelInfoSupportedParameterDefaultMultiModalContentImageBlockModelMultiModalContentTextBlockModelMultiModalSnippetModelNamespaceDescriptionNamespaceDescriptionIndexedFieldsNativeCreateIndexOptionsOperationListOperationModelOrganizationOrganizationListPaginationPaginationResponsePatchIndexDeploymentRequestPatchIndexSchemaPatchSemanticTextFieldPdfReferenceModelPodDeploymentProjectProjectListRankedDocumentReadCapacityDedicatedReadCapacityDedicatedConfigReadCapacityDedicatedSettingsReadCapacityDedicatedSpecResponseReadCapacityOnDemandReadCapacityOnDemandSpecResponseReadCapacityStatusReasoningReferenceModelRerankOptionsRerankResultRerankResultUsageResponseStringFieldResponseStringFieldFullTextSearchResponseStringFieldFullTextSearchNgramRestoreJobListRestoreJobModelRoleBindingRoleBindingInputRoleBindingListScalingConfigManualScalingConfigManualInputScoredPineconeRecordSearchDocumentsOptionsSearchDocumentsResponseSearchMatchTermsSearchRecordsResponseSearchRecordsResponseResultSearchUsageSemanticTextFieldServiceAccountServiceAccountListServiceAccountWithSecretSparseEmbeddingSparseValuesSparseVectorFieldStartImportOptionsStartImportResponseStreamedChatCompletionResponseStringFieldStringFieldFullTextSearchStringFieldFullTextSearchNgramStringListFieldTextReferenceModelTextSnippetModelTokenCountsUpdateAssistantOptionsUpdateAssistantResponseUpdateBackupScheduleOptionsUpdateDocumentRecordUpdateDocumentsOptionsUpdateDocumentsResponseUpsertDocumentsOptionsUpsertDocumentsResponseUsageUsageModelUserUserList
      Type Aliases
      AdminClientConfigurationBackupIdBackupScheduleFrequencyBackupScheduleIdBackupStatusBatchUpsertDispositionBatchUpsertErrorModeByocSpecResponseChatModelEnumChatModelEnumCollectionNameCollectionStatusConfigureIndexOptionsConfigureIndexResourceOptionsCreateApiKeyOptionsCreateBackupResourceOptionsCreateIndexFromBackupResourceOptionsCreateIndexOptionsCreateIndexReadCapacityCreateIndexSchemaFieldCreateIndexSpecCreateInviteOptionsCreateProjectOptionsCreateRoleBindingOptionsCreateServiceAccountOptionsDedicatedNodeTypeDeleteAllOptionsDeleteBackupOptionsDeleteCollectionOptionsDeleteIndexOptionsDeleteManyOptionsDeleteOneOptionsDeletionProtectionDerivedDeriveFailureReasonDescribeBackupOptionsDescribeCollectionOptionsDescribeIndexOptionsDescribeIndexStatsOptionsDescribeRestoreJobOptionsEmbeddingFetchAPIFetchByMetadataOptionsFetchByMetadataResponseFetchOptionsFetchResponseFinishReasonEnumFinishReasonEnumFullTextSearchStringFieldHTTPHeadersIndexDeploymentIndexDeploymentRequestIndexMetricIndexModelSpecIndexNameIndexSchemaFieldIndexShapeIndexStateIndexStatsDescriptionIndexStatsNamespaceSummaryIntegratedRecordLegacyConfigureIndexOptionsLegacyIndexSpecListInvitesOptionsListOptionsListRoleBindingsOptionsListServiceAccountsOptionsListUsersOptionsMessagesModelModelIndexEmbedMultiModalContentBlocksModelNativeConfigureIndexOptionsOperationUsagePineconeConfigurationPineconeRecordPodSpecPodTypeQueryByRecordIdQueryByVectorValuesQueryOptionsQueryResponseQuerySharedReadCapacityReadCapacityDedicatedParamsReadCapacityOnDemandParamsReadCapacityResponseReadCapacityScalingReadCapacityStateRecordIdRecordMetadataRecordMetadataValueRecordSparseValuesRecordValuesRestoreJobIdScheduledBackupStatusSearchRecordsOptionsSearchRecordsQuerySearchRecordsRerankSearchRecordsVectorServerlessSpecResponseSnippetModelStreamedChatResponseTypedIndexSchemaFieldTypedReferenceModelUpdateApiKeyOptionsUpdateOptionsUpdateOrganizationOptionsUpdateProjectOptionsUpdateServiceAccountOptionsUploadableUploadFileOptionsUpsertFileOptionsUpsertOptionsUpsertRecordsOptions
      Functions
      References