Class PreviewAlpha

constructor

• new Preview(config: PineconeConfiguration): Preview
  Alpha

  Parameters

  • config: PineconeConfiguration

  Returns Preview

Alphaindexes

const list = await pc.preview.indexes.list();
Copy

index

• index(options: IndexOptions): PreviewIndex
  Alpha

  Returns a PreviewIndex for performing data-plane document operations against a schema-based index.

  Provide either name (resolves the host via describeIndex) or host (skips that round-trip). When both are provided, host is used directly and name is only used for cache-key purposes.

  Parameters

  • options: IndexOptions

    IndexOptions — must include at least name or host.

  Returns PreviewIndex

  Example

  // Resolve host automatically from the index name
  const previewIndex = pc.preview.index({ name: 'my-schema-index' });
  
  // Skip host resolution when you already know the host URL
  const previewIndex = pc.preview.index({ host: 'https://my-host.pinecone.io' });
  
  const result = await previewIndex.upsertDocuments('my-namespace', {
    documents: [{ _id: 'doc-1', content: 'Hello world' }],
  });
  Copy