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

    Type Alias TypedIndexSchemaField

    TypedIndexSchemaField:
        | { type: "boolean" } & BooleanField
        | { type: "dense_vector" } & DenseVectorField & {
            metric: IndexMetric | string & {};
        }
        | { type: "float" } & FloatField
        | { type: "integer" } & IntegerField
        | { type: "semantic_text" } & SemanticTextField & {
            metric?: IndexMetric | string & {};
        }
        | { type: "sparse_vector" } & SparseVectorField
        | { type: "string" } & ResponseStringField
        | { type: "string_list" } & StringListField

    A field in the schema of an existing index. Check type to narrow to a specific field.

    Alongside the searchable fields you declared at creation, this covers the metadata field types (boolean, float, integer, string_list, and string without full-text search) that Pinecone adds automatically from document metadata at upsert time. See CreateIndexSchemaField for the set you can declare yourself.

    Type Declaration

    • { type: "boolean" } & BooleanField
      • type: "boolean"

        Field kind used to narrow this schema variant.

    • { type: "dense_vector" } & DenseVectorField & {
          metric: IndexMetric | string & {};
      }
      • type: "dense_vector"

        Field kind used to narrow this schema variant.

      • metric: IndexMetric | string & {}

        Similarity metric used by this field.

    • { type: "float" } & FloatField
      • type: "float"

        Field kind used to narrow this schema variant.

    • { type: "integer" } & IntegerField
      • type: "integer"

        Field kind used to narrow this schema variant.

    • { type: "semantic_text" } & SemanticTextField & {
          metric?: IndexMetric | string & {};
      }
      • type: "semantic_text"

        Field kind used to narrow this schema variant.

      • Optionalmetric?: IndexMetric | string & {}

        Similarity metric used by this field.

    • { type: "sparse_vector" } & SparseVectorField
      • type: "sparse_vector"

        Field kind used to narrow this schema variant.

    • { type: "string" } & ResponseStringField
      • type: "string"

        Field kind used to narrow this schema variant.

    • { type: "string_list" } & StringListField
      • type: "string_list"

        Field kind used to narrow this schema variant.

    Settings
    Member Visibility