Adds examples.

Author: szabosteve

specification/inference/put_custom/examples/PutCustomRequestExample1.yaml

@@ -0,0 +1,24 @@
+summary: Custom text embedding task (OpenAI)
+description: Run `PUT _inference/text_embedding/custom-embeddings` to create an inference endpoint that performs a text embedding task.
+method_request: 'PUT _inference/text_embedding/custom-embeddings'
+# type: "request"
+value: |-
+  {
+      "service": "custom",
+      "service_settings": {
+          "secret_parameters": {
+              "api_key": "<api key>"
+          },
+          "url": "https://api.openai.com/v1/embeddings",
+          "headers": {
+              "Authorization": "Bearer ${api_key}",
+              "Content-Type": "application/json;charset=utf-8"
+          },
+          "request": "{\"input\": ${input}, \"model\": \"text-embedding-3-small\"}",
+          "response": {
+              "json_parser": {
+                  "text_embeddings": "$.data[*].embedding[*]"
+              }
+          }
+      }
+  }

specification/inference/put_custom/examples/PutCustomRequestExample2.yaml

@@ -0,0 +1,25 @@
+summary: Custom rerank task (Cohere APIv2)
+description: Run `PUT _inference/rerank/custom-rerank` to create an inference endpoint that performs a rerank task.
+method_request: 'PUT _inference/rerank/custom-rerank'
+# type: "request"
+value: |-
+  {
+    "service": "custom",
+    "service_settings": {
+        "secret_parameters": {
+            "api_key": "<api key>"
+        },
+        "url": "https://api.cohere.com/v2/rerank",
+        "headers": {
+            "Authorization": "bearer ${api_key}",
+            "Content-Type": "application/json"
+        },
+        "request": "{\"documents\": ${input}, \"query\": ${query}, \"model\": \"rerank-v3.5\"}",
+        "response": {
+            "json_parser": {
+                "reranked_index":"$.results[*].index",
+                "relevance_score":"$.results[*].relevance_score"
+            }
+        }
+    }
+  }

specification/inference/put_custom/examples/PutCustomRequestExample3.yaml

@@ -0,0 +1,31 @@
+summary: Custom text embedding task (Cohere APIv2)
+description: Run `PUT _inference/text_embedding/custom-text-embedding` to create an inference endpoint that performs a text embedding task.
+method_request: 'PUT _inference/text_embedding/custom-text-embedding'
+# type: "request"
+value: |-
+  {
+    "service": "custom",
+    "service_settings": {
+        "secret_parameters": {
+            "api_key": "<api key>"
+        },
+        "url": "https://api.cohere.com/v2/embed",
+        "headers": {
+            "Authorization": "bearer ${api_key}",
+            "Content-Type": "application/json"
+        },
+        "request": "{\"texts\": ${input}, \"model\": \"embed-v4.0\", \"input_type\": ${input_type}}",
+        "response": {
+            "json_parser": {
+                "text_embeddings":"$.embeddings.float[*]"
+            }
+        },
+        "input_type": {
+            "translation": {
+                "ingest": "search_document",
+                "search": "search_query"
+            },
+            "default": "search_document"
+        }
+    }
+  }

specification/inference/put_custom/examples/PutCustomRequestExample4.yaml

@@ -0,0 +1,25 @@
+summary: Custom rerank task (Jina AI)
+description: Run `PUT _inference/rerank/custom-rerank-jina` to create an inference endpoint that performs a rerank task.
+method_request: 'PUT _inference/rerank/custom-rerank-jina'
+# type: "request"
+value: |-
+  {
+    "service": "custom",
+    "service_settings": {
+      "secret_parameters": {
+        "api_key": "<api key>"
+      },    
+      "url": "https://api.jina.ai/v1/rerank",
+      "headers": {
+        "Content-Type": "application/json",
+        "Authorization": "Bearer ${api_key}"
+      },
+      "request": "{\"model\": \"jina-reranker-v2-base-multilingual\",\"query\": ${query},\"documents\":${input}}",
+      "response": {
+        "json_parser": {
+          "relevance_score": "$.results[*].relevance_score",
+          "reranked_index": "$.results[*].index"
+        }
+      }
+    }
+  }

specification/inference/put_custom/examples/PutCustomRequestExample5.yaml

@@ -0,0 +1,24 @@
+summary: Custom text embedding task (Hugging Face)
+description: Run `PUT _inference/text_embedding/custom-text-embedding-hf` to create an inference endpoint that performs a text embedding task by using the Qwen/Qwen3-Embedding-8B model.
+method_request: 'PUT _inference/text_embedding/custom-text-embedding-hf'
+# type: "request"
+value: |-
+  {
+    "service": "custom",
+    "service_settings": {
+        "secret_parameters": {
+            "api_key": "<api key>"
+        },
+        "url": "<dedicated inference endpoint on HF>/v1/embeddings",
+        "headers": {
+            "Authorization": "Bearer ${api_key}",
+            "Content-Type": "application/json"
+        },
+        "request": "{\"input\": ${input}}",
+        "response": {
+            "json_parser": {
+                "text_embeddings":"$.data[*].embedding[*]"
+            }
+        }
+    }
+  }