com.hw.pinecone.service.VectorService Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hw.pinecone.service;
import com.hw.pinecone.entity.vector.*;
import io.reactivex.Single;
import retrofit2.http.*;
import java.util.List;
/**
* Vector Operations
*
* @author HamaWhite
*/
public interface VectorService {
/**
* The Query operation searches a namespace, using a query vector.
* It retrieves the ids of the most similar items in a namespace, along with their similarity scores.
*
* @param request the QueryRequest containing the query vector and other parameters
* @return a Single emitting a QueryResponse with the results of the query operation
*/
@POST("/query")
Single query(@Body QueryRequest request);
/**
* The Fetch operation looks up and returns vectors, by ID, from a single namespace.
* The returned vectors include the vector data and/or metadata.
*
* @param ids the vector ids to fetch.
* @param namespace the namespace for the vectors.
* @return a Single emitting the FetchResponse containing the fetched vectors
*/
@GET("/vectors/fetch")
Single fetch(@Query("ids") List ids, @Query("namespace") String namespace);
/**
* The Upsert operation writes vectors into a namespace.
* If a new value is upserted for an existing vector id, it will overwrite the previous value.
*
* @param request the UpsertRequest containing the vectors to be upserted
* @return a Single emitting an UpsertResponse indicating the result of the upsert operation
*/
@POST("/vectors/upsert")
Single upsert(@Body UpsertRequest request);
}