File tree Expand file tree Collapse file tree 5 files changed +12
-8
lines changed
pinecone-core/src/main/scala/io/cequence/pineconescala Expand file tree Collapse file tree 5 files changed +12
-8
lines changed Original file line number Diff line number Diff line change @@ -35,7 +35,7 @@ or to *pom.xml* (if you use maven)
35
35
## Config ⚙️
36
36
37
37
- Env. variables: ` PINECONE_SCALA_CLIENT_API_KEY ` , and ` PINECONE_SCALA_CLIENT_ENV `
38
- - File config (default): [ pinecone-scala-client.conf] ( ./pinecone-client/src/main/resources/pinecone-scala-client.conf )
38
+ - File config (default): [ pinecone-scala-client.conf] ( ./pinecone-client/src/main/resources/pinecone-scala-client.conf )
39
39
40
40
## Usage 👨🎓
41
41
@@ -365,6 +365,9 @@ Examples:
365
365
println(stats)
366
366
)
367
367
```
368
+ ## Demo
369
+
370
+ For ready-to-run demos pls. refer to a separate seed project demonstrating how to use the client: [ here] ( https://github.com/cequence-io/pinecone-scala-demo ) .
368
371
369
372
## FAQ 🤔
370
373
Original file line number Diff line number Diff line change @@ -3,6 +3,6 @@ package io.cequence.pineconescala.domain
3
3
case class PVector (
4
4
id : String ,
5
5
values : Seq [Double ],
6
- sparseValues : Option [SparseVector ],
6
+ sparseValues : Option [SparseVector ] = None ,
7
7
metadata : Map [String , String ]
8
8
)
Original file line number Diff line number Diff line change @@ -2,7 +2,8 @@ package io.cequence.pineconescala.domain.response
2
2
3
3
case class CollectionInfo (
4
4
name : String ,
5
- // The size of the collection in bytes.
6
- size : Int ,
7
- status : String
5
+ // The size of the collection in bytes. Not available when initializing
6
+ size : Option [Int ],
7
+ dimension : Int ,
8
+ status : String // TODO: this can be potentially an enum (== IndexStatus?)
8
9
)
Original file line number Diff line number Diff line change @@ -12,7 +12,7 @@ case class QueryResponse(
12
12
case class Match (
13
13
id : String ,
14
14
score : Double ,
15
- values : Seq [Double ],
15
+ values : Seq [Double ], // not returned when includeValues = false
16
16
sparseValues : Option [SparseVector ],
17
- metadata : Map [String , String ]
17
+ metadata : Option [ Map [String , String ]] // not returned when includeMetadata = true
18
18
)
Original file line number Diff line number Diff line change @@ -21,7 +21,7 @@ trait PineconeServiceConsts {
21
21
val Query = QuerySettings (
22
22
topK = 10 ,
23
23
includeValues = false ,
24
- includeMetadata = false
24
+ includeMetadata = true // by default include metadata
25
25
)
26
26
27
27
val CreateIndex = CreateIndexSettings (
You can’t perform that action at this time.
0 commit comments