[7.16] Add docs and release notes for 7.16.0

Co-authored-by: Seth Michael Larson <[email protected]>
elastic · Dec 29, 2021 · 32059ac · 32059ac
1 parent a0e3ae8
commit 32059ac
Show file tree

Hide file tree

Showing 4 changed files with 184 additions and 1 deletion.
diff --git a/docs/guide/app-search-api.asciidoc b/docs/guide/app-search-api.asciidoc
@@ -11,6 +11,7 @@
 * <<app-search-crawler-apis>>
 * <<app-search-curation-apis>>
 * <<app-search-meta-engine-apis>>
+* <<app-search-adaptive-relevance-apis>>
 
 [[app-search-initializing]]
 === Initializing the Client
@@ -918,3 +919,124 @@ app_search.delete_crawler_sitemap(
   sitemap_id=sitemap_id
 )
 ---------------
+
+[[app-search-adaptive-relevance-apis]]
+=== Adaptive Relevance APIs
+
+==== Settings
+
+[source,python]
+---------------
+# Get adaptive relevenace settings for an Engine
+app_search.get_adaptive_relevance_settings(
+  engine_name="adaptive-engine"
+)
+{
+  "curation": {
+    "enabled": True,
+    "mode": "manual",
+    "timeframe": 7,
+    "max_size": 3,
+    "min_clicks": 20,
+    "schedule_frequency": 1,
+    "schedule_unit": "day"
+  }
+}
+
+# Enable automatic adaptive relevance
+app_search.put_adaptive_relevance_settings(
+  engine_name="adaptive-engine",
+  body={
+    "curation": {
+      "mode": "automatic"
+    }
+  }
+)
+---------------
+
+==== Suggestions
+
+[source,python]
+---------------
+# List all adaptive relevance suggestions for an engine
+app_search.list_adaptive_relevance_suggestions(
+  engine_name="adaptive-engine"
+)
+{
+  "meta": {
+    "page": {
+      "current": 1,
+      "total_pages": 1,
+      "total_results": 2,
+      "size": 25
+    }
+  },
+  "results": [
+    {
+      "query": "forest",
+      "type": "curation",
+      "status": "pending",
+      "updated_at": "2021-09-02T07:22:23Z",
+      "created_at": "2021-09-02T07:22:23Z",
+      "promoted": [
+        "park_everglades",
+        "park_american-samoa",
+        "park_arches"
+      ],
+      "operation": "create"
+    },
+    {
+      "query": "park",
+      "type": "curation",
+      "status": "pending",
+      "updated_at": "2021-10-22T07:34:12Z",
+      "created_at": "2021-10-22T07:34:54Z",
+      "promoted": [
+        "park_yellowstone"
+      ],
+      "operation": "create",
+      "override_manual_curation": true
+    }
+  ]
+}
+
+# Get adaptive relevance suggestions for a query
+app_search.get_adaptive_relevance_suggestions(
+  engine_name="adaptive-engine",
+  query="forest",
+)
+{
+  "meta": {
+    "page": {
+      "current": 1,
+      "total_pages": 1,
+      "total_results": 1,
+      "size": 25
+    }
+  },
+  "results": [
+    {
+      "query": "forest",
+      "type": "curation",
+      "status": "pending",
+      "updated_at": "2021-09-02T07:22:23Z",
+      "created_at": "2021-09-02T07:22:23Z",
+      "promoted": [
+        "park_everglades",
+        "park_american-samoa",
+        "park_arches"
+      ],
+      "operation": "create"
+    }
+  ]
+}
+
+# Update status of adaptive relevance suggestions
+app_search.put_adaptive_relevance_suggestions(
+  engine_name="adaptive-engine",
+  suggestions=[
+    {"query": "forest", "type": "curation", "status": "applied"},
+    {"query": "mountain", "type": "curation", "status": "rejected"}
+  ]
+)
+---------------
diff --git a/docs/guide/release-notes/7-16-0.asciidoc b/docs/guide/release-notes/7-16-0.asciidoc
@@ -0,0 +1,20 @@
+[[release-notes-7-16-0]]
+=== 7.16.0 Release Notes
+
+[discrete]
+==== General
+
+- Deprecated support for Python 2.7, 3.4, and 3.5. Support will be removed in v8.0.0.
+- Updated APIs to the 7.16 specification
+
+[discrete]
+==== App Search
+
+- Added the `get_adaptive_relevance_settings`, `put_adaptive_relevance_settings`, `get_adaptive_relevance_suggestions`, `list_adaptive_relevance_suggestions`, `put_adaptive_relevance_suggestions`
+- Fixed the pagination parameters for `list_crawler_crawl_requests` and `list_crawler_process_crawls` APIs to `current_page` and `page_size`, were previously `limit`.
+
+
+[discrete]
+==== Workplace Search
+
+- Added the `list_documents` API
diff --git a/docs/guide/release-notes/index.asciidoc b/docs/guide/release-notes/index.asciidoc
@@ -4,13 +4,15 @@
 [discrete]
 === 7.x
 
-* <<release-notes-7-14-0, 7.15.0 Release Notes>>
+* <<release-notes-7-16-0, 7.16.0 Release Notes>>
+* <<release-notes-7-15-0, 7.15.0 Release Notes>>
 * <<release-notes-7-14-0, 7.14.0 Release Notes>>
 * <<release-notes-7-13-0, 7.13.0 Release Notes>>
 * <<release-notes-7-12-0, 7.12.0 Release Notes>>
 * <<release-notes-7-11-0, 7.11.0 Release Notes>>
 * <<release-notes-7-10-0, 7.10.0-beta1 Release Notes>>
 
+include::7-16-0.asciidoc[]
 include::7-15-0.asciidoc[]
 include::7-14-0.asciidoc[]
 include::7-13-0.asciidoc[]

diff --git a/docs/guide/workplace-search-api.asciidoc b/docs/guide/workplace-search-api.asciidoc
@@ -129,6 +129,45 @@ workplace_search.get_document(
 }
 ---------------
 
+==== List Documents
+
+List documents inside a Content Source
+
+[source,python]
+---------------
+# Request:
+workplace_search.list_documents(
+    content_source_id="<CONTENT_SOURCE_ID>"
+)
+
+# Response:
+{
+  "meta": {
+    "page": {
+      "current": 1,
+      "total_pages": 1,
+      "total_results": 2,
+      "size": 10
+    },
+    "warnings": [],
+    "cursor": {
+      "current": null,
+      "next": "eyJzb3J0Ijp7Il9zY29yZSI6ImRlc2MifSwic2VhcmNoX2FmdGVyIjpbMS4wLCJkb2MtNjFiY2VkNjQ1MzU5OTEyMjlmNTM1MWEzIl19"
+    }
+  },
+  "results": [
+    {
+      "last_updated": "2021-12-17T20:04:37+00:00",
+      "updated_at": "2021-12-17T20:04:37+00:00",
+      "content_source_id": "61bced325359912c2f5351a0",
+      "source": "custom",
+      "id": "doc-61bced5553599152f25351a2"
+    },
+    ...
+  ]
+}
+---------------
+
 ==== Delete documents
 
 To remove documents from a custom content source use the `delete_documents()` method