Auto-generated. Updating Vectara public protos. (cd64312c808e9e859bfd…

…0f5c156fc292ee99914f).

admin.proto

@@ -57,8 +57,10 @@ message Corpus {
 
   repeated Dimension custom_dimensions = 13;
   repeated FilterAttribute filter_attributes = 14;
+
 }
 
+
 // A custom dimension is additional numeric metadata that you want to affect
 // Vectara's scoring.  For example, these could be "number of stars" ratings,
 // or other business metrics like a product's margins that you want to use
@@ -120,6 +122,20 @@ message CreateCorpusResponse {
   Status status = 2;
 }
 
+message UpdateCorpusRequest {
+  // Corpus id to update.
+  uint32 id = 1;
+  // Name to be updated.
+  optional string name = 2;
+  // Description to be updated.
+  optional string description = 3;
+}
+
+message UpdateCorpusResponse {
+  // The Status of the update.
+  Status status = 1;
+}
+
 message DeleteCorpusRequest {
   option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
     json_schema: { required: [ "customerId", "corpusId" ] }
@@ -205,6 +221,8 @@ message CorpusSize {
   int64 epoch_secs = 1;
 
   // The size of the corpus.
+  // This is the sum of the number of characters in the
+  // text and metadata of all documents in the corpus.
   uint64 size = 2;
 }
 
@@ -224,6 +242,7 @@ message ReadCorpusRequest {
   bool read_custom_dimensions = 1004;
   // Set to true to read the filter attributes of the corpus.
   bool read_filter_attributes = 1005;
+
 }
 
 message ReadCorpusResponse {
@@ -249,6 +268,7 @@ message ReadCorpusResponse {
     repeated FilterAttribute filter_attribute = 6;
     // Status of the filter attributes.
     Status filter_attribute_status = 1006;
+
   }
 
   // Information about the requested corpora.

common.proto

@@ -96,3 +96,4 @@ message StorageQuota {
   // storage quota.
   int64 num_metadata_chars = 2;
 }
+

core_services.proto

@@ -22,6 +22,7 @@ message IndexCoreDocumentRequest {
   int64 corpus_id = 2;
   // The document being indexed.
   com.vectara.indexing.CoreDocument document = 3;
+
 }
 
 message IndexCoreDocumentResponse {

services.proto

@@ -31,6 +31,7 @@ message IndexDocumentRequest {
   int64 corpus_id = 2;
   // The Document to index.
   com.vectara.indexing.Document document = 3;
+
 }
 
 message IndexDocumentResponse {
@@ -104,6 +105,14 @@ service AdminService {
     };
   }
 
+  rpc UpdateCorpus(com.vectara.admin.UpdateCorpusRequest)
+    returns (com.vectara.admin.UpdateCorpusResponse) {
+    option (google.api.http) = {
+      post: "/v1/update-corpus"
+      body: "*"
+    };
+  }
+
   rpc DeleteCorpus(com.vectara.admin.DeleteCorpusRequest) returns (com.vectara.admin.DeleteCorpusResponse){
     option (google.api.http) = {
       post: "/v1/delete-corpus"

serving.proto

@@ -163,6 +163,8 @@ message QueryRequest {
     // chars_before is used for showing the end user the characters leading up
     // to the result snippet.  This can help the end-user understand the
     // context of that result. Ignored if sentences_before is set.
+    // Vectara will capture the full sentence that contains the captured characters,
+    // so as to not lose the meaning caused by a truncated word or sentence.
     int32 chars_before = 5 [
       (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
         example: "30"
@@ -171,6 +173,8 @@ message QueryRequest {
     // chars_after is used for showing the end user the characters after the
     // result snippet.  This can help the end-user understand the context of
     // that result. Ignored if sentences_before is set.
+    // Vectara will capture the full sentence that contains the captured characters,
+    // so as to not lose the meaning caused by a truncated word or sentence.
     int32 chars_after = 10 [
       (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
         example: "30"
@@ -227,6 +231,10 @@ message QueryRequest {
     // Reranker-specific parameters.  The numbering starts from 100, and moves
     // upwards in increments of 5.
     optional MMRConfig mmr_config = 100;
+
+    // User function that will be executed on each search result.
+    // May return a double or null. If this is null the item is skipped.
+    optional string user_function = 105;
   }
   RerankingConfig reranking_config = 30;
 
@@ -366,6 +374,7 @@ message ResponseSet {
   // within the summary can be used for correlation.
   repeated Summary summary = 25;
 
+
   // Populated for streaming requests only. This id should matched against
   // the query response in order to know which query generated this object.
   int32 future_id = 1010;