action vectara_query {
  label: "Query"
  description: "Query"
  provider: vectara
  method: POST
  path: "/v1/query"
  encoding: json
  output: {
    type: "object"
    properties: {
      metrics: {
        type: "object"
        description: "Basic performance metrics that can be attached to a server response."
        properties: {
          queryEncodeMs: {
            type: "integer"
            format: "int64"
            description: "How long it took to encode the query."
          }
          rerankMs: {
            type: "integer"
            format: "int64"
            description: "How long it took to rerank the results."
          }
          retrievalMs: {
            type: "integer"
            format: "int64"
            description: "How long it took to retrieve relevant results."
          }
          userdataRetrievalMs: {
            type: "integer"
            format: "int64"
            description: "How long it took to retrieve user data."
          }
        }
      }
      responseSet: {
        type: "array"
        items: {
          type: "object"
          properties: {
            document: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  id: {
                    type: "string"
                  }
                  metadata: {
                    type: "array"
                    items: {
                      type: "object"
                      properties: {
                        name: {
                          type: "string"
                        }
                        value: {
                          type: "string"
                        }
                      }
                    }
                  }
                }
              }
            }
            response: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  corpusKey: {
                    type: "object"
                    properties: {
                      corpusId: {
                        type: "integer"
                        format: "int64"
                        description: "The Corpus ID."
                      }
                      customerId: {
                        type: "integer"
                        format: "int64"
                        description: "The Customer ID."
                      }
                      dim: {
                        type: "array"
                        description: "Weights on custom dimensions for the corpus."
                        items: {
                          type: "object"
                          description: "Defined the weight of a custom dimension at query time."
                          properties: {
                            name: {
                              type: "object"
                              additionalProperties: true
                            }
                            weight: {
                              type: "object"
                              additionalProperties: true
                            }
                          }
                        }
                      }
                      metadataFilter: {
                        type: "string"
                      }
                      semantics: {
                        type: "string"
                        description: "Semantics controls the interpretation of the query string by the\nserver, and can be used to override the default semantics assigned\nin the corpus definition.\n\n\n\n\n - DEFAULT: Use corpus-assigned semantics.  This is the most common setting.\n - QUERY: Use query semantics.  This is also common.\n - RESPONSE: Use response semantics.  Usage of this is rare."
                        enum: ["DEFAULT", "QUERY", "RESPONSE"]
                      }
                    }
                  }
                  documentIndex: {
                    type: "integer"
                    format: "int64"
                    description: "Use this ID to find the document in the ResponseSet."
                  }
                  metadata: {
                    type: "array"
                    items: {
                      type: "object"
                      additionalProperties: true
                    }
                  }
                  score: {
                    type: "number"
                    format: "float"
                    description: "The score used for ranking results.  The higher the score, the better the match."
                  }
                  text: {
                    type: "string"
                  }
                }
              }
            }
            status: {
              type: "array"
              description: "Potentially multiple warnings."
              items: {
                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"
                  }
                }
              }
            }
          }
        }
      }
      status: {
        type: "array"
        items: {
          type: "object"
          additionalProperties: true
        }
      }
    }
  }
}