KnnQuery interface is not complete

[bijela-gora]

🐛 Bug Report

According to the documentation the KnnQuery interface must contain optional property similarity (type float).

Because of the missing similarity property on KnnQuery interface it is inconvenient to use .search API:

Additionally to that k and num_candidates properties should have type of integer.

Expected behavior

export interface KnnQuery {
  field: Field
  query_vector?: QueryVector
  query_vector_builder?: QueryVectorBuilder
  k: integer
  num_candidates: integer
  similarity?: float
  boost?: float
  filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
}

[JoshMock]

Thanks for the report! I'll take a look soon.

Most type definitions in this repo are automatically generated using the specification Elastic maintains in the elastic/elasticsearch-specificaton repo. I'll see if the issue can be resolved there first, so that all clients can benefit from the improvement.

In the meantime, as with any build-time TypeScript error, you can always use ignore instructions to skip over typing bugs that you know will not result in errors at runtime.

[bijela-gora]

@JoshMock hi

Thanks for your time and attention here.

There is event PR opened elastic/elasticsearch-specification#2261 and I think it is ready to be merged. But I added small suggestion: elastic/elasticsearch-specification#2261 (comment)

[JoshMock]

elastic/elasticsearch-specification#2261 is merged and backported. This will be fixed in upcoming patch and minor version releases.