弹性工作搜索 0.3.0

为Elastic Workplace Search提供的一-party Python客户端。

内容

• 入门
• 使用
• 常见问题解答
• 贡献
• 许可协议

---

入门 🐣

支持Python 2.7和Python 3.3+。

依赖于futures和requests。

使用pip <http://pypi.python.org/pypi/pip>安装

$ python -m pip install elastic_workplace_search

您还可以下载并安装项目源代码

$ python setup.py install

使用

创建新的客户端

  from elastic_workplace_search import Client
  authorization_token = 'authorization token'
  client = Client(authorization_token)

在创建内容源后，获取您的访问令牌和内容源密钥。

更改API端点

client = Client(authorization_token, "https://your-server.example.com/api/ws/v1")

自定义源文档

文档API功能位于client.documents模块中。

索引文档

将文档索引到自定义内容源

  content_source_key = 'content source key'
  documents = [
    {
      'id': '1234',
      'url': 'https://github.com/elastic/workplace-search-python',
      'title': 'Elastic Workplace Search Official Python Client',
      'body': 'A descriptive body, with document contents and metadata'
    }
  ]

  client.documents.index_documents(content_source_key, documents)

删除文档

从自定义内容源中删除文档

  content_source_key = 'content source key'
  ids = ['1234']

  client.documents.delete_documents(content_source_key, ids)

权限

权限API功能位于client.permissions模块中。

列出所有权限

content_source_key = 'content source key'

client.permissions.list_all_permissions(content_source_key)

分页列出所有权限

content_source_key = 'content source key'

client.permissions.list_all_permissions(content_source_key, size=20, current=2)

检索用户的权限

content_source_key = 'content source key'
user = 'enterprise_search'

client.permissions.get_user_permissions(content_source_key, user)

向用户添加权限

content_source_key = 'content source key'
user = 'enterprise_search'
permissions = ['permission1']

client.permissions.add_user_permissions(content_source_key, 'enterprise_search', { 'permissions': permissions })

更新用户的权限

content_source_key = 'content source key'
user = 'enterprise_search'
permissions = ['permission2']

client.permissions.update_user_permissions(content_source_key, 'enterprise_search', { 'permissions': permissions })

从用户中删除权限

content_source_key = 'content source key'
user = 'enterprise_search'
permissions = ['permission2']

client.permissions.remove_user_permissions(content_source_key, 'enterprise_search', { 'permissions': permissions })

常见问题解答 🔮

我在哪里报告客户端的问题？

如果某些功能不符合预期，请打开问题。

贡献 🚀

我们欢迎对项目做出贡献。在开始之前，请注意...

• 在提交拉取请求之前，请先创建一个问题来讨论您提案的范围。
• 当合适时，请编写简洁的代码和文档。

许可证 📗

Apache 2.0 © Elastic

感谢所有贡献者！