ListCorpora

v1.0.0

List Corpora

Input

{
  "type": "object",
  "properties": {
    "customer-id": {
      "type": "integer"
    },
    "filter": {
      "type": "string",
      "description": "A regex to match corpora against."
    },
    "numResults": {
      "type": "integer",
      "format": "int64",
      "description": "The maximum results to return."
    },
    "pageKey": {
      "type": "string",
      "format": "byte",
      "description": "A key that is passed in to retrieve a specific page of results."
    }
  },
  "required": [
    "customer-id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "corpus": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customDimensions": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "A custom dimension is additional numeric metadata that you want to affect\nVectara's scoring.  For example, these could be \"number of stars\" ratings,\nor other business metrics like a product's margins that you want to use\nto boost where a result is in the list.",
              "properties": {
                "description": {
                  "type": "string",
                  "description": "A description for the custom dimension."
                },
                "indexingDefault": {
                  "type": "number",
                  "format": "double",
                  "description": "The default value to give to documents for this custom dimension."
                },
                "name": {
                  "type": "string",
                  "description": "The name of the custom dimension.  The maximum length of the name is\n8 characters."
                },
                "servingDefault": {
                  "type": "number",
                  "format": "double",
                  "description": "The default weight to give this dimension when running queries. A value of\n0.0, for example, gives it no weight at all."
                }
              }
            }
          },
          "description": {
            "type": "string",
            "description": "A description for the corpus."
          },
          "dtProvision": {
            "type": "string",
            "format": "int64",
            "description": "The time at which the corpus was provisioned."
          },
          "enabled": {
            "type": "boolean",
            "description": "Whether the corpus is enabled for use or not."
          },
          "encoderId": {
            "type": "string",
            "format": "uint64",
            "description": "This is an advanced setting for changing the underlying model type.  The\ndefault value is \"1\", which is Vectara's high-performing global model.\nUnderlying models may be swapped for some paying customers by contacting\nour support team."
          },
          "encrypted": {
            "type": "boolean",
            "description": "Encryption is on by default and cannot be turned off."
          },
          "filterAttributes": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "Defines metadata fields that can be used in predicate queries.",
              "properties": {
                "description": {
                  "type": "string",
                  "description": "An optional description."
                },
                "indexed": {
                  "type": "boolean",
                  "description": "Whether the field is indexed for maximum query speed."
                },
                "level": {
                  "type": "string",
                  "enum": [
                    "FILTER_ATTRIBUTE_LEVEL__UNDEFINED",
                    "FILTER_ATTRIBUTE_LEVEL__DOCUMENT",
                    "FILTER_ATTRIBUTE_LEVEL__DOCUMENT_PART"
                  ]
                },
                "name": {
                  "type": "string",
                  "description": "Name of the field, as seen in metadata."
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "FILTER_ATTRIBUTE_TYPE__UNDEFINED",
                    "FILTER_ATTRIBUTE_TYPE__INTEGER",
                    "FILTER_ATTRIBUTE_TYPE__INTEGER_LIST",
                    "FILTER_ATTRIBUTE_TYPE__REAL",
                    "FILTER_ATTRIBUTE_TYPE__REAL_LIST",
                    "FILTER_ATTRIBUTE_TYPE__TEXT",
                    "FILTER_ATTRIBUTE_TYPE__TEXT_LIST"
                  ]
                }
              }
            }
          },
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "The Corpus ID."
          },
          "metadataMaxBytes": {
            "type": "integer",
            "format": "int64",
            "description": "An optional maximum size of the metadata that each document can contain."
          },
          "name": {
            "type": "string",
            "description": "The name of the corpus."
          },
          "swapIenc": {
            "type": "boolean",
            "description": "The default query encoder is designed for normal question-answering types\nof queries when the text contains the answer.  Swapping the index encoder\nis generally rare, but can be used to help directly match questions to\nquestions.  This can be useful if you have a FAQ dataset and you want to\ndirectly match the user question to the question in the FAQ."
          },
          "swapQenc": {
            "type": "boolean"
          },
          "textless": {
            "type": "boolean",
            "description": "When a corpus is \"textless\", Vectara does not store the original text.\nInstead, Vectara converts the text to vectors and only retains metadata."
          }
        }
      }
    },
    "pageKey": {
      "type": "string",
      "format": "byte",
      "description": "A key that is passed into a subsequent result in order to\nretrieve the next page of results."
    },
    "status": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "OK",
            "FAILURE",
            "UNKNOWN",
            "INVALID_ARGUMENT",
            "DEADLINE_EXCEEDED",
            "ALREADY_EXISTS",
            "PERMISSION_DENIED",
            "RESOURCE_EXHAUSTED",
            "FAILED_PRECONDITION",
            "ABORTED",
            "OUT_OF_RANGE",
            "UNIMPLEMENTED",
            "INTERNAL",
            "UNAVAILABLE",
            "DATA_LOSS",
            "UNAUTHENTICATED",
            "BAD_REQUEST",
            "UNAUTHORIZED",
            "FORBIDDEN",
            "NOT_FOUND",
            "METHOD_NOT_ALLOWED",
            "CONFLICT",
            "UNSUPPORTED_MEDIA_TYPE",
            "TOO_MANY_REQUESTS",
            "INTERNAL_SERVER_ERROR",
            "NOT_IMPLEMENTED",
            "SERVICE_UNAVAILABLE",
            "INSUFFICIENT_STORAGE",
            "UNPARSEABLE_RESPONSE",
            "DISABLED_CUSTOMER",
            "INVALID_CUSTOMER_ID",
            "DISABLED_CORPUS",
            "INVALID_CORPUS_ID",
            "DISABLED_API_KEY",
            "EXPIRED_API_KEY",
            "INVALID_API_KEY",
            "CMK_INACCESSIBLE",
            "QRY__DISABLED_CORPUS",
            "QRY__DOCUMENT_DB_FAILURE",
            "QRY__ENCODER_FAILURE",
            "QRY__INTERRUPTED",
            "QRY__INVALID_CORPUS",
            "QRY__INVALID_START",
            "QRY__INVALID_NUM_RESULTS",
            "QRY__INVALID_CONTEXT",
            "QRY__MISSING_QUERY",
            "QRY__MISSING_CORPUS",
            "QRY__TIMEOUT",
            "QRY__TOO_MANY_CORPORA",
            "QRY__TOO_MANY_QUERIES",
            "QRY__VECTOR_INDEX_FAILURE",
            "QRY__INVALID_DIMENSION",
            "QRY__INVALID_CLIENTKEY",
            "QRY__DECRYPTION_FAILURE",
            "QRY__INVALID_RERANKER",
            "QRY__PARTIAL_RERANK",
            "QRY__RERANK_FAILURE",
            "QRY__TOO_MANY_RESULT_ROWS",
            "QRY__PARTIAL_RETRIEVAL",
            "CX_SPECS__INVALID_JSON",
            "CX_SPECS__UNREGISTERED_TYPE",
            "CX_SPECS__MISSING_SPEC",
            "CX_SPECS__MISSING_TYPE",
            "CX_SPECS__UNPARSEABLE_SPEC",
            "ADM__INVALID_CUSTOMER_ID",
            "ADM__INVALID_CORPUS_ID",
            "ADM__INVALID_ENCODER_ID",
            "ADM__INVALID_ROLE_ID",
            "ADM__ROLE_ALREADY_EXISTS",
            "ADM__ONLY_ONE_OWNER_SUPPORTED",
            "ADM__INVALID_PERMISSION",
            "ADM__ROLECREATION_FAILURE",
            "ADM__USER_EMAIL_NOT_AVAIALBLE",
            "ADM__USERNAME_NOT_AVAILABLE",
            "ADM__SIGNUP_MISSING_NAME",
            "ADM__SIGNUP_MISSING_ORG",
            "ADM__SIGNUP_MISSING_EMAIL",
            "ADM__SIGNUP_MISSING_PAYMENT",
            "ADM__SIGNUP_MISSING_PLAN",
            "ADM__SIGNUP_MISSING_PASSWORD",
            "ADM__SIGNUP_INVALID_NAME",
            "ADM__SIGNUP_INVALID_ORG",
            "ADM__SIGNUP_INVALID_EMAIL",
            "ADM__SIGNUP_INVALID_PAYMENT",
            "ADM__SIGNUP_INVALID_PLAN",
            "ADM__SIGNUP_INVALID_PASSWORD",
            "ADM__SIGNUP_INVALID_ACCOUNT_ALIAS",
            "ADM__SIGNUP_INVALID_EMAIL_VALIDATION_CODE",
            "ADM__SIGNUP_MISSING_COUNTRY_CODE",
            "ADM__SIGNUP_ROOT_EMAIL_NOT_AVAILABLE",
            "ADM__CUST_MARK_DELETE_FAILED",
            "ADM__CUST_FAISS_DEALLOC_FAILED",
            "ADM__CORPUS_LIMIT_REACHED",
            "ADM__STRIPE_CARD_DECLINED",
            "ADM__STRIPE_PROCESSING_ERROR",
            "ADM__EMAIL_VALIDATION_REQUEST_NOT_FOUND",
            "ADM__EMAIL_NOT_VALIDATED",
            "ADM__CHANGE_PLAN__NO_CURRENT_PLAN",
            "ADM__CHANGE_PLAN__REQUIRES_MANUAL_CHANGE",
            "ADM__CHANGE_PLAN__INVALID_PLAN_ID",
            "ADM__CHANGE_PLAN__NO_PAYMENT_SOURCE",
            "ADM__CHANGE_PLAN__INVALID_EFFECTIVE_DATE",
            "ADM__CHANGE_PLAN__CONFLICTING_CHANGE",
            "SCM__MISCONFIGURED_CONNECTION",
            "STATS_DB_READ_FAILURE",
            "VDB__TEXT_READ_FAILURE",
            "REBUILD__LOW_RECALL",
            "REBUILD__INDEX_UPLOAD_FAILURE",
            "REBUILD__UPDATE_JOURNAL_FAILURE",
            "REBUILD__UPDATE_FAISSPARAMS_FAILURE",
            "REBUILD__NO_DATA",
            "REBUILD__EVALUATION",
            "IDX__TRANSIENT_PARTIAL_DELETION_FAILURE",
            "IDX__PERMANENT_PARTIAL_DELETION_FAILURE"
          ]
        },
        "statusDetail": {
          "type": "string"
        }
      }
    }
  }
}