• Helper function to describe a Pinecone index. Use it to check if a newly created index is ready for use.

    Parameters

    • params: { clientParams?: PineconeConfiguration; name: string }

      The params for describing a Pinecone index.

      • OptionalclientParams?: PineconeConfiguration

        The params to initialize Pinecone.

      • name: string

        The name of the Pinecone index to describe.

    Returns Promise<IndexModel>

    A description of the Pinecone index.