PineconeDocument Class

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.Pinecone

Assembly:: Microsoft.SemanticKernel.Connectors.Pinecone.dll

Package:: Microsoft.SemanticKernel.Connectors.Pinecone v1.20.0-alpha

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Pinecone Document entity.

public class PineconeDocument

type PineconeDocument = class

Public Class PineconeDocument

Inheritance: Object
PineconeDocument

Constructors

PineconeDocument(ReadOnlyMemory<Single>, String, Dictionary<String,Object>, SparseVectorData, Nullable<Single>)

Initializes a new instance of the PineconeDocument class.

Properties

CreatedAt	The timestamp, used to identify when document was created.
DocumentId	The document ID, used to identify the source text this document was created from
Id	The unique ID of a Document
Metadata	The metadata associated with the document
Score	Gets or Sets Score
SourceId	The source ID, used to identify the source text this document was created from.
SparseValues	Gets or Sets SparseValues
Text	The text of the document, if the document was created from text.
Values	Vector dense data. This should be the same length as the dimension of the index being queried.

Methods

Create(String, ReadOnlyMemory<Single>)	Initializes a new instance of the PineconeDocument class.
GetSerializedMetadata()	Serializes the metadata to JSON.
WithMetadata(Dictionary<String,Object>)	Sets metadata for PineconeDocument class.
WithSparseValues(SparseVectorData)	Sets sparse vector data for PineconeDocument class.

Extension Methods

ToMemoryRecord(PineconeDocument)

Maps PineconeDocument instance to MemoryRecord.

Applies to

Partager via