Skip to content

Commit eaa6c1e

Browse files
Auto-generated API code (#2851)
1 parent a5e8f74 commit eaa6c1e

File tree

4 files changed

+26
-11
lines changed

4 files changed

+26
-11
lines changed

docs/reference.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6209,6 +6209,7 @@ client.indices.deleteIndexTemplate({ name })
62096209
[discrete]
62106210
==== delete_template
62116211
Delete a legacy index template.
6212+
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
62126213

62136214
{ref}/indices-delete-template-v1.html[Endpoint documentation]
62146215
[source,ts]
@@ -6822,7 +6823,7 @@ error.
68226823

68236824
[discrete]
68246825
==== get_template
6825-
Get index templates.
6826+
Get legacy index templates.
68266827
Get information about one or more index templates.
68276828

68286829
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
@@ -7279,7 +7280,7 @@ will be closed temporarily and then reopened in order to apply the changes.
72797280

72807281
[discrete]
72817282
==== put_template
7282-
Create or update an index template.
7283+
Create or update a legacy index template.
72837284
Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
72847285
Elasticsearch applies templates to new indices based on an index pattern that matches the index name.
72857286

src/api/api/indices.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -633,7 +633,7 @@ export default class Indices {
633633
}
634634

635635
/**
636-
* Delete a legacy index template.
636+
* Delete a legacy index template. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
637637
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-template-v1.html | Elasticsearch API documentation}
638638
*/
639639
async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteTemplateResponse>
@@ -1427,7 +1427,7 @@ export default class Indices {
14271427
}
14281428

14291429
/**
1430-
* Get index templates. Get information about one or more index templates. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
1430+
* Get legacy index templates. Get information about one or more index templates. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
14311431
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-template-v1.html | Elasticsearch API documentation}
14321432
*/
14331433
async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetTemplateResponse>
@@ -1898,7 +1898,7 @@ export default class Indices {
18981898
}
18991899

19001900
/**
1901-
* Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order. Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Indices matching multiple templates** Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.
1901+
* Create or update a legacy index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order. Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Indices matching multiple templates** Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.
19021902
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-templates-v1.html | Elasticsearch API documentation}
19031903
*/
19041904
async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutTemplateResponse>

src/api/types.ts

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1720,7 +1720,7 @@ export interface SearchShardProfile {
17201720
index: IndexName
17211721
node_id: NodeId
17221722
searches: SearchSearchProfile[]
1723-
shard_id: long
1723+
shard_id: integer
17241724
}
17251725

17261726
export interface SearchSmoothingModelContainer {
@@ -13239,6 +13239,11 @@ export interface InferenceInferenceEndpointInfo extends InferenceInferenceEndpoi
1323913239
task_type: InferenceTaskType
1324013240
}
1324113241

13242+
export interface InferenceInferenceEndpointInfoJinaAi extends InferenceInferenceEndpoint {
13243+
inference_id: string
13244+
task_type: InferenceTaskTypeJinaAi
13245+
}
13246+
1324213247
export interface InferenceInferenceResult {
1324313248
text_embedding_bytes?: InferenceTextEmbeddingByteResult[]
1324413249
text_embedding_bits?: InferenceTextEmbeddingByteResult[]
@@ -13347,6 +13352,8 @@ export type InferenceTaskSettings = any
1334713352

1334813353
export type InferenceTaskType = 'sparse_embedding' | 'text_embedding' | 'rerank' | 'completion' | 'chat_completion'
1334913354

13355+
export type InferenceTaskTypeJinaAi = 'text_embedding' | 'rerank'
13356+
1335013357
export interface InferenceTextEmbeddingByteResult {
1335113358
embedding: InferenceDenseByteVector
1335213359
}
@@ -13584,7 +13591,7 @@ export interface InferencePutJinaaiRequest extends RequestBase {
1358413591
task_settings?: InferenceJinaAITaskSettings
1358513592
}
1358613593

13587-
export type InferencePutJinaaiResponse = InferenceInferenceEndpointInfo
13594+
export type InferencePutJinaaiResponse = InferenceInferenceEndpointInfoJinaAi
1358813595

1358913596
export interface InferencePutMistralRequest extends RequestBase {
1359013597
task_type: InferenceMistralTaskType
@@ -20143,7 +20150,7 @@ export interface SnapshotSnapshotShardFailure {
2014320150
index: IndexName
2014420151
node_id?: Id
2014520152
reason: string
20146-
shard_id: Id
20153+
shard_id: integer
2014720154
index_uuid: Id
2014820155
status: string
2014920156
}

src/api/typesWithBodyKey.ts

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1779,7 +1779,7 @@ export interface SearchShardProfile {
17791779
index: IndexName
17801780
node_id: NodeId
17811781
searches: SearchSearchProfile[]
1782-
shard_id: long
1782+
shard_id: integer
17831783
}
17841784

17851785
export interface SearchSmoothingModelContainer {
@@ -13481,6 +13481,11 @@ export interface InferenceInferenceEndpointInfo extends InferenceInferenceEndpoi
1348113481
task_type: InferenceTaskType
1348213482
}
1348313483

13484+
export interface InferenceInferenceEndpointInfoJinaAi extends InferenceInferenceEndpoint {
13485+
inference_id: string
13486+
task_type: InferenceTaskTypeJinaAi
13487+
}
13488+
1348413489
export interface InferenceInferenceResult {
1348513490
text_embedding_bytes?: InferenceTextEmbeddingByteResult[]
1348613491
text_embedding_bits?: InferenceTextEmbeddingByteResult[]
@@ -13589,6 +13594,8 @@ export type InferenceTaskSettings = any
1358913594

1359013595
export type InferenceTaskType = 'sparse_embedding' | 'text_embedding' | 'rerank' | 'completion' | 'chat_completion'
1359113596

13597+
export type InferenceTaskTypeJinaAi = 'text_embedding' | 'rerank'
13598+
1359213599
export interface InferenceTextEmbeddingByteResult {
1359313600
embedding: InferenceDenseByteVector
1359413601
}
@@ -13870,7 +13877,7 @@ export interface InferencePutJinaaiRequest extends RequestBase {
1387013877
}
1387113878
}
1387213879

13873-
export type InferencePutJinaaiResponse = InferenceInferenceEndpointInfo
13880+
export type InferencePutJinaaiResponse = InferenceInferenceEndpointInfoJinaAi
1387413881

1387513882
export interface InferencePutMistralRequest extends RequestBase {
1387613883
task_type: InferenceMistralTaskType
@@ -20725,7 +20732,7 @@ export interface SnapshotSnapshotShardFailure {
2072520732
index: IndexName
2072620733
node_id?: Id
2072720734
reason: string
20728-
shard_id: Id
20735+
shard_id: integer
2072920736
index_uuid: Id
2073020737
status: string
2073120738
}

0 commit comments

Comments
 (0)