Skip to content

Commit 4a9925b

Browse files
lcawllcawl
authored
Fix inference examples (#4566)
1 parent 5572fbe commit 4a9925b

File tree

5 files changed

+288
-4
lines changed

5 files changed

+288
-4
lines changed

‎docs/add-new-api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,12 +173,13 @@ Add an `examples` folder and `request` and `xxx_response` subfolders (where `xxx
173173

174174
These examples are for use in the API documentation and must adhere to the [OpenAPI 3.0 Example object specification](https://spec.openapis.org/oas/v3.0.3#example-object). They must have a `value` field that contains the request or response body.
175175
If there are multiple examples for the endpoint, they must each have a brief `summary` field, which is used as the label for the example. You can also optionaly provide an explanation in a `description` field.
176+
In order to generate curl and console examples automatically, the request examples must also contain a `method_request`.
176177

177178
For example:
178179

179180
```yaml
180181
summary: Sequence query
181-
# method_request: GET /my-data-stream/_eql/search
182+
method_request: GET /my-data-stream/_eql/search
182183
# type: request
183184
description: >
184185
Run `GET /my-data-stream/_eql/search` to search for a sequence of events.

‎output/schema/schema.json

Lines changed: 69 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎specification/inference/put_hugging_face/examples/request/PutHuggingFaceRequestExample2.yaml

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
summary: A rerank task
22
description: Run `PUT _inference/rerank/hugging-face-rerank` to create an inference endpoint that performs a `rerank` task type.
3-
# method_request: "PUT _inference/rerank/hugging-face-rerank"
3+
method_request: 'PUT _inference/rerank/hugging-face-rerank'
44
# type: "request"
55
value: |-
66
{
@@ -14,3 +14,77 @@ value: |-
1414
"top_n": 3
1515
}
1616
}
17+
alternatives:
18+
- language: Python
19+
code: |-
20+
resp = client.inference.put(
21+
task_type="rerank",
22+
inference_id="hugging-face-rerank",
23+
inference_config={
24+
"service": "hugging_face",
25+
"service_settings": {
26+
"api_key": "hugging-face-access-token",
27+
"url": "url-endpoint"
28+
},
29+
"task_settings": {
30+
"return_documents": True,
31+
"top_n": 3
32+
}
33+
},
34+
)
35+
- language: JavaScript
36+
code: |-
37+
const response = await client.inference.put({
38+
task_type: "rerank",
39+
inference_id: "hugging-face-rerank",
40+
inference_config: {
41+
service: "hugging_face",
42+
service_settings: {
43+
api_key: "hugging-face-access-token",
44+
url: "url-endpoint",
45+
},
46+
task_settings: {
47+
return_documents: true,
48+
top_n: 3,
49+
},
50+
},
51+
});
52+
- language: Ruby
53+
code: |-
54+
response = client.inference.put(
55+
task_type: "rerank",
56+
inference_id: "hugging-face-rerank",
57+
body: {
58+
"service": "hugging_face",
59+
"service_settings": {
60+
"api_key": "hugging-face-access-token",
61+
"url": "url-endpoint"
62+
},
63+
"task_settings": {
64+
"return_documents": true,
65+
"top_n": 3
66+
}
67+
}
68+
)
69+
- language: PHP
70+
code: |-
71+
$resp = $client->inference()->put([
72+
"task_type" => "rerank",
73+
"inference_id" => "hugging-face-rerank",
74+
"body" => [
75+
"service" => "hugging_face",
76+
"service_settings" => [
77+
"api_key" => "hugging-face-access-token",
78+
"url" => "url-endpoint",
79+
],
80+
"task_settings" => [
81+
"return_documents" => true,
82+
"top_n" => 3,
83+
],
84+
],
85+
]);
86+
- language: curl
87+
code:
88+
"curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d
89+
'{\"service\":\"hugging_face\",\"service_settings\":{\"api_key\":\"hugging-face-access-token\",\"url\":\"url-endpoint\"},\"ta\
90+
sk_settings\":{\"return_documents\":true,\"top_n\":3}}' \"$ELASTICSEARCH_URL/_inference/rerank/hugging-face-rerank\""

‎specification/inference/rerank/examples/request/RerankRequestExample2.yaml

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
summary: Rerank task
22
description: Run `POST _inference/rerank/bge-reranker-base-mkn` to perform reranking on the example input via Hugging Face
3-
# method_request: "POST _inference/rerank/bge-reranker-base-mkn"
3+
method_request: 'POST _inference/rerank/bge-reranker-base-mkn'
44
# type: "request"
55
value: |-
66
{
@@ -9,3 +9,73 @@ value: |-
99
"return_documents": false,
1010
"top_n": 2
1111
}
12+
alternatives:
13+
- language: Python
14+
code: |-
15+
resp = client.inference.rerank(
16+
inference_id="bge-reranker-base-mkn",
17+
input=[
18+
"luke",
19+
"like",
20+
"leia",
21+
"chewy",
22+
"r2d2",
23+
"star",
24+
"wars"
25+
],
26+
query="star wars main character",
27+
return_documents=False,
28+
top_n=2,
29+
)
30+
- language: JavaScript
31+
code: |-
32+
const response = await client.inference.rerank({
33+
inference_id: "bge-reranker-base-mkn",
34+
input: ["luke", "like", "leia", "chewy", "r2d2", "star", "wars"],
35+
query: "star wars main character",
36+
return_documents: false,
37+
top_n: 2,
38+
});
39+
- language: Ruby
40+
code: |-
41+
response = client.inference.rerank(
42+
inference_id: "bge-reranker-base-mkn",
43+
body: {
44+
"input": [
45+
"luke",
46+
"like",
47+
"leia",
48+
"chewy",
49+
"r2d2",
50+
"star",
51+
"wars"
52+
],
53+
"query": "star wars main character",
54+
"return_documents": false,
55+
"top_n": 2
56+
}
57+
)
58+
- language: PHP
59+
code: |-
60+
$resp = $client->inference()->rerank([
61+
"inference_id" => "bge-reranker-base-mkn",
62+
"body" => [
63+
"input" => array(
64+
"luke",
65+
"like",
66+
"leia",
67+
"chewy",
68+
"r2d2",
69+
"star",
70+
"wars",
71+
),
72+
"query" => "star wars main character",
73+
"return_documents" => false,
74+
"top_n" => 2,
75+
],
76+
]);
77+
- language: curl
78+
code:
79+
'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d
80+
''{"input":["luke","like","leia","chewy","r2d2","star","wars"],"query":"star wars main
81+
character","return_documents":false,"top_n":2}'' "$ELASTICSEARCH_URL/_inference/rerank/bge-reranker-base-mkn"'

‎specification/inference/rerank/examples/request/RerankRequestExample3.yaml

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
summary: Rerank task
22
description: Run `POST _inference/rerank/bge-reranker-base-mkn` to perform reranking on the example input via Hugging Face
3-
# method_request: "POST _inference/rerank/bge-reranker-base-mkn"
3+
method_request: 'POST _inference/rerank/bge-reranker-base-mkn'
44
# type: "request"
55
value: |-
66
{
@@ -9,3 +9,73 @@ value: |-
99
"return_documents": true,
1010
"top_n": 3
1111
}
12+
alternatives:
13+
- language: Python
14+
code: |-
15+
resp = client.inference.rerank(
16+
inference_id="bge-reranker-base-mkn",
17+
input=[
18+
"luke",
19+
"like",
20+
"leia",
21+
"chewy",
22+
"r2d2",
23+
"star",
24+
"wars"
25+
],
26+
query="star wars main character",
27+
return_documents=True,
28+
top_n=3,
29+
)
30+
- language: JavaScript
31+
code: |-
32+
const response = await client.inference.rerank({
33+
inference_id: "bge-reranker-base-mkn",
34+
input: ["luke", "like", "leia", "chewy", "r2d2", "star", "wars"],
35+
query: "star wars main character",
36+
return_documents: true,
37+
top_n: 3,
38+
});
39+
- language: Ruby
40+
code: |-
41+
response = client.inference.rerank(
42+
inference_id: "bge-reranker-base-mkn",
43+
body: {
44+
"input": [
45+
"luke",
46+
"like",
47+
"leia",
48+
"chewy",
49+
"r2d2",
50+
"star",
51+
"wars"
52+
],
53+
"query": "star wars main character",
54+
"return_documents": true,
55+
"top_n": 3
56+
}
57+
)
58+
- language: PHP
59+
code: |-
60+
$resp = $client->inference()->rerank([
61+
"inference_id" => "bge-reranker-base-mkn",
62+
"body" => [
63+
"input" => array(
64+
"luke",
65+
"like",
66+
"leia",
67+
"chewy",
68+
"r2d2",
69+
"star",
70+
"wars",
71+
),
72+
"query" => "star wars main character",
73+
"return_documents" => true,
74+
"top_n" => 3,
75+
],
76+
]);
77+
- language: curl
78+
code:
79+
'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d
80+
''{"input":["luke","like","leia","chewy","r2d2","star","wars"],"query":"star wars main
81+
character","return_documents":true,"top_n":3}'' "$ELASTICSEARCH_URL/_inference/rerank/bge-reranker-base-mkn"'

0 commit comments

Comments
 (0)