{"id":19319241,"url":"https://github.com/oramasearch/oramacloud-client-kotlin","last_synced_at":"2026-05-17T03:08:53.087Z","repository":{"id":250916344,"uuid":"835458985","full_name":"oramasearch/oramacloud-client-kotlin","owner":"oramasearch","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-09T19:25:45.000Z","size":103,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-27T13:48:54.203Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oramasearch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-29T22:13:29.000Z","updated_at":"2024-09-09T19:25:48.000Z","dependencies_parsed_at":"2024-10-18T18:11:32.188Z","dependency_job_id":"bd4976be-1842-4df1-be36-85d6132d470a","html_url":"https://github.com/oramasearch/oramacloud-client-kotlin","commit_stats":null,"previous_names":["askorama/oramacloud-client-kotlin","oramasearch/oramacloud-client-kotlin"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/oramasearch/oramacloud-client-kotlin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oramasearch%2Foramacloud-client-kotlin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oramasearch%2Foramacloud-client-kotlin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oramasearch%2Foramacloud-client-kotlin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oramasearch%2Foramacloud-client-kotlin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oramasearch","download_url":"https://codeload.github.com/oramasearch/oramacloud-client-kotlin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oramasearch%2Foramacloud-client-kotlin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33126086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T18:38:32.183Z","status":"online","status_checked_at":"2026-05-17T02:00:05.366Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T01:22:49.300Z","updated_at":"2026-05-17T03:08:53.058Z","avatar_url":"https://github.com/oramasearch.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"Orama Cloud Kotlin Client\n---\n\nThis repository contains Orama's Cloud Multiplatform Kotlin Client.\nDevelopers can use this library to interact with Orama using Kotlin in multiple plataforms,\n\n## Installing using Maven\n\nTo install, make sure to enable Maven repository and include the dependency in your build file `gradle.build.kts`.\n\n```\nrepositories {\n   mavenCentral()\n}\n\ndependencies {\n   implementation \"com.orama:oramasearch-client-kotlin:$OramaClientVersion\"\n}\n```\n\n## Usage\n\nPerforming full-text, vector, or hybrid search:\n\nFirst, you need to do is to instantiate the client passing your `endpoint` and `apiKey`.\nAfter that, use the `SearchParams` to prepare you query.\nNow, just call the `client.search` method with the parameters and a proper callback handler.\n\n```kotlin\n@Serializable\ndata class MyDoc (\n    val title: String,\n    val category: String,\n    val path: String,\n    val content: String,\n    val section: String\n)\n\nval client = OramaClient(\n    endpoint = \"\u003cORAMA CLOUD URL\u003e\",\n    apiKey = \"\u003cORAMA CLOUD API KEY\u003e\"\n)\n\nval searchParams = SearchParams.builder(\n        term = \"install\",\n        mode = Mode.FULLTEXT // Modes: FULLTEXT, VECTOR and HYBRID\n    ).build()\n\nlaunch {\n    val results = client.search(searchParams, MyDoc.serializer())\n}\n```\n\nPerforming an answer session:\n\n```kotlin\nval client = OramaClient(\n    endpoint = \"\u003cORAMA CLOUD URL\u003e\",\n    apiKey = \"\u003cORAMA CLOUD API KEY\u003e\"\n)\n\nval answerParams = AnswerParams(\n    userContext = null,\n    oramaClient = client,\n    inferenceType = InferenceType.DOCUMENTATION,\n    initialMessages = mutableListOf\u003cMessage\u003e()\n)\n\nval answerSession = AnswerSession(\n    answerParams = answerParams,\n    events = object : AnswerEventListener {\n        override fun onStateChange(interactions: MutableList\u003cInteraction\u003e) {\n            // Process list of interaction post-response\n        }\n    }\n)\n\nrunBlocking {\n    val answer = answerSession.ask(AskParams(\n        query = \"What's the best movie to watch with the family?\"\n    ))\n\n    println(answer)\n}\n```\n\n## License\n\n[Apache 2.0](/LICENSE.md)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foramasearch%2Foramacloud-client-kotlin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foramasearch%2Foramacloud-client-kotlin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foramasearch%2Foramacloud-client-kotlin/lists"}