Auto-generated. Updating Vectara public protos. (33af6c40981ac3ce9ec2…

…41fd8176d8e332ee032e).

admin.proto

@@ -50,7 +50,11 @@ message Corpus {
   // default value is "1", which is Vectara's high-performing global model.
   // Underlying models may be swapped for some paying customers by contacting
   // our support team.
-  uint64 encoder_id = 10;
+  uint64 encoder_id = 10 [deprecated = true];
+
+  // New encoder_name field
+  string encoder_name = 16;
+
   // An optional maximum size of the metadata that each document can contain.
   uint32 metadata_max_bytes = 11;
 
@@ -224,6 +228,14 @@ message CorpusSize {
   // This is the sum of the number of characters in the
   // text and metadata of all documents in the corpus.
   uint64 size = 2;
+  // Count of actual characters in the text that will be searched.
+  uint64 num_chars = 3;
+  // Count of metadata characters such as URL, author, date of creation etc.
+  uint64 num_metadata_chars = 4;
+  // Number of documents.
+  uint64 num_docs = 5;
+  // Number of document parts.
+  uint64 num_parts = 6;
 }
 
 message ReadCorpusRequest {

admin_account.proto

@@ -20,6 +20,10 @@ message TextSize {
   uint64 num_chars = 1;
   // Count of metadata characters such as URL, author, date of creation etc.
   uint64 num_metadata_chars = 2;
+  // Number of documents.
+  uint64 num_docs = 3;
+  // Number of document parts.
+  uint64 num_parts = 4;
 }
 
 message ComputeAccountSizeResponse {

admin_apikey.proto

@@ -91,6 +91,8 @@ message ListApiKeysRequest {
   // [Optional] Get API keys of these types.
   // Default: If not set, API_KEY_TYPE__SERVING and API_KEY_TYPE__SERVING_INDEXING are returned.
   repeated ApiKeyType api_key_type = 3;
+  // [Optional] Filter API keys by corpus ID.
+  optional uint32 corpus_id = 4;
   // If set, returns corpus name & id associated with api keys.
   bool read_corpora_info = 1000;
 }

common.proto

@@ -97,3 +97,5 @@ message StorageQuota {
   int64 num_metadata_chars = 2;
 }
 
+
+

indexing.proto

@@ -56,3 +56,4 @@ message Document {
   // of sections.
   repeated Section section = 10;
 }
+

indexing_core.proto

@@ -42,4 +42,3 @@ message CoreDocument {
   repeated CustomDimension custom_dims = 5;
 }
 
-

list_documents.proto

@@ -1,6 +1,7 @@
 syntax = "proto3";
 
 import "attribute.proto";
+import "common.proto";
 
 option java_package = "com.vectara.lists";
 option java_outer_classname = "ListProtos";
@@ -26,6 +27,7 @@ message ListDocumentsRequest {
   // Otherwise, only documents that match all of the specified metadata
   // will be returned. The syntax is the same as for QueryRequest.metadata.
   string metadata_filter = 20;
+
 }
 
 // Response of listing documents in a corpus.

serving.proto

@@ -15,7 +15,7 @@ package com.vectara.serving;
 message CustomDimension {
   // The name of the custom dimension.
   string name = 1;
-  // The weight of the custom dimension on the query side. This gets multipled
+  // The weight of the custom dimension on the query side. This gets multiplied
   // by the matching index custom dimension weight and added to the score.
   double weight = 2;
 }
@@ -138,9 +138,11 @@ message SummarizationRequest {
 
   // If unset or true, the response will include the factual consistency score.
   optional bool factual_consistency_score = 230;
+
 }
 
 
+
 message QueryRequest {
   // The query text to use from the end user.
   string query = 5;
@@ -222,11 +224,14 @@ message QueryRequest {
 
   // Configuration options to apply to the reranking.
   message RerankingConfig {
-    // Which reranking model to use if reranking.  Currently, the only IDs
+    // Which reranking model to use if reranking (deprecated).  Currently, the only IDs
     // available are:
     // - 272725718, Maximum Marginal Relevance Reranker
     // - 272725719, Vectara Multilingual Reranker v1 Reranker
-    uint32 reranker_id = 5;
+    uint32 reranker_id = 5 [deprecated = true];
+
+    // The name of the reranker to use if reranking. Allows for easier identification.
+    string reranker_name = 6;
 
     // Reranker-specific parameters.  The numbering starts from 100, and moves
     // upwards in increments of 5.
@@ -235,6 +240,20 @@ message QueryRequest {
     // 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;
+
+    // To chain re-rankers together, this field is used to specify the configuration
+    // for the next reranker. Meaning that reranker will be applied first
+    // and then the next reranker will be applied on the results.
+    //
+    // To use this field, set the reranker_id and respective parameters like mmr_config and
+    // user_function.
+    optional RerankingConfig next_reranking_config = 110;
+
+    // The limit that this particular reranker will return
+    optional uint32 limit = 115;
+
+    // The score cutoff this particular reranker will return
+    optional float cutoff = 120;
   }
   RerankingConfig reranking_config = 30;
 
@@ -262,6 +281,10 @@ message CitationParams {
   // It can also be customized to access the part/doc fields by passing
   // the field name in curly braces. e.g., {doc.title} or {part.page}
   // Final result would look like [Title](https://my.doc/foo/2/1)
+  // If you want the index of the result, and customize it as well with some
+  // additional text, you can access it like this: {index}
+  // So for example if you choose to give this value: {doc.title} - result: {index}
+  // Final result would look like [Title - result: N](https://my.doc/foo/2/1)
   optional string text_pattern = 15;
 }
 
@@ -336,6 +359,7 @@ message Summary {
   int32 future_id = 1010;
 }
 
+
 // A document part that matched a query.
 message Response {
   // The text of the document part after being modified by the context config.
@@ -374,6 +398,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;

status.proto

@@ -22,7 +22,7 @@ enum StatusCode {               // Reasons for an error
   // INTERNAL_SERVER_ERROR error codes. Try your request again with backoff. 
   // See https://status.vectara.com for the latest info on any outages.
   // If the problem persists, please contact us via support or via our community forums 
-  // at https://discuss.vectara.com if you’re a Growth user.
+  // at https://discuss.vectara.com if you're a Standard user or on the free trial plan.
   FAILURE = 1;
 
   // gRPC Codes ----------------------------------------------------------------
@@ -32,7 +32,7 @@ enum StatusCode {               // Reasons for an error
   // FAILURE, and INTERNAL_SERVER_ERROR error codes. Try your request again 
   // with backoff. See https://status.vectara.com for the latest info on any outages.
   // If the problem persists, please contact us via support or via our community forums 
-  // at https://discuss.vectara.com if you’re a Growth user.
+  // at https://discuss.vectara.com if you're a Standard user or on the free trial plan.
   UNKNOWN             = 2;
   // INVALID_ARGUMENT (3): The request contains an invalid argument. Verify the argument values and try again.
   INVALID_ARGUMENT    = 3;
@@ -45,7 +45,7 @@ enum StatusCode {               // Reasons for an error
   RESOURCE_EXHAUSTED  = 8;
   // FAILED_PRECONDITION (9): The request failed because your system does not meet the correct preconditions. 
   FAILED_PRECONDITION = 9;
-  // ABORTED (10): The indexing request was aborted because of a system error. Try again later.
+  // ABORTED (10): If encountered when indexing, the indexing request was aborted because of a system error. Try again later.
   ABORTED             = 10;
   OUT_OF_RANGE        = 11;
   // UNIMPLEMENTED (12): The request contains an unsupported operation. Verify the values and try again.
@@ -54,12 +54,12 @@ enum StatusCode {               // Reasons for an error
   // INTERNAL_SERVER_ERROR error codes. Try your request again with backoff. 
   // See https://status.vectara.com for the latest info on any outages.
   // If the problem persists, please contact us via support or via our community forums 
-  // at https://discuss.vectara.com if you’re a Growth user.
+  // at https://discuss.vectara.com if you're a Standard user or on the free trial plan.
   INTERNAL            = 13;
   // UNAVAILABLE (14): The service you requested is currently unavailable. Check our status page at status.vectara.com for more information.
   UNAVAILABLE         = 14;
   DATA_LOSS           = 15;
-  // UNAUTHENTICATED (16): The indexing request does not have valid authentication credentials. Verify that you have attached authentication credentials with the request.
+  // UNAUTHENTICATED (16): The request does not have valid authentication credentials. Verify that you have attached authentication credentials with the request.
   UNAUTHENTICATED     = 16;
 
   // HTTP Codes ----------------------------------------------------------------
@@ -253,6 +253,7 @@ enum StatusCode {               // Reasons for an error
   ADM__CUST_ALREADY_ACTIVE = 2534;
   ADM__CUST_REACTIVATE_FAILED = 2535;
   ADM__CUST_ENABLEMENT_FAILED = 2536;
+  ADM__CUST_MARK_EXPIRED_FAILED = 2537;
 
   ADM__CORPUS_LIMIT_REACHED = 2524;