Search

Hybrid Search (POST)

Performs search, using a combination of syntactic and semantic search.

POST
/search.hybrid

Authorization

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Request Body

limit?integer

The maximum number of items to return in a page. The default is '10'.

Formatint32
Range0 <= value <= 50
namespacesearch-hybrid-namespace

The namespaces for hybrid search.

Value in"account" | "article" | "capability" | "component" | "conversation" | "custom_object" | "custom_part" | "custom_work" | "dashboard" | "dataset" | "dev_user" | "enhancement" | "feature" | "group" | "incident" | "issue" | "linkable" | "microservice" | "object_member" | "opportunity" | "part" | "product" | "project" | "question_answer" | "rev_org" | "rev_user" | "runnable" | "service_account" | "sys_user" | "tag" | "task" | "ticket" | "vista" | "widget" | "work"
querystring

The query string.

Formattext
Length1 <= length <= 400
semantic_weight?number

The weightage for semantic search. Values between 0 and 1 are accepted.

Formatfloat
Range0 <= value <= 1

Response Body

curl -X POST "https://api.devrev.ai/search.hybrid" \  -H "Content-Type: application/json" \  -d '{    "namespace": "account",    "query": "string"  }'
{
  "results": [
    {
      "type": "account",
      "modified_date": "2023-01-01T12:00:00.000Z",
      "snippet": "string",
      "account": {
        "display_id": "string",
        "id": "string",
        "display_name": "string"
      },
      "comments": [
        {
          "comment": {
            "display_id": "string",
            "id": "string",
            "sync_metadata": {
              "external_reference": "string",
              "origin_system": "string"
            }
          },
          "created_by": {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          },
          "created_date": "2023-01-01T12:00:00.000Z",
          "object": "string",
          "panels": [
            "alerts"
          ],
          "references": [
            {
              "type": "account",
              "display_id": "string",
              "id": "string",
              "display_name": "string"
            }
          ],
          "snippet": "string"
        }
      ]
    }
  ]
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}