Package co.elastic.clients.elasticsearch.inference

Class CustomServiceSettings.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<CustomServiceSettings.Builder>
co.elastic.clients.elasticsearch.inference.CustomServiceSettings.Builder
All Implemented Interfaces:
WithJson<CustomServiceSettings.Builder>, ObjectBuilder<CustomServiceSettings>
Enclosing class:
CustomServiceSettings
public static class CustomServiceSettings.Builder extends WithJsonObjectBuilderBase<CustomServiceSettings.Builder> implements ObjectBuilder<CustomServiceSettings>
Builder for CustomServiceSettings.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • batchSize

      public final CustomServiceSettings.Builder batchSize(@Nullable Integer value)
      Specifies the batch size used for the semantic_text field. If the field is not provided, the default is 10. The batch size is the maximum number of inputs in a single request to the upstream service. The chunk within the batch are controlled by the selected chunking strategy for the semantic_text field.

      API name: batch_size

    • headers

      public final CustomServiceSettings.Builder headers(Map<String,String> map)
      Specifies the HTTP header parameters – such as Authorization or Content-Type – that are required to access the custom service. For example: 
       "headers": {
   "Authorization": "Bearer ${api_key}",
   "Content-Type": "application/json;charset=utf-8"
 }

      API name: headers

      Adds all entries of map to headers.

    • headers

      public final CustomServiceSettings.Builder headers(String key, String value)
      Specifies the HTTP header parameters – such as Authorization or Content-Type – that are required to access the custom service. For example: 
       "headers": {
   "Authorization": "Bearer ${api_key}",
   "Content-Type": "application/json;charset=utf-8"
 }

      API name: headers

      Adds an entry to headers.

    • inputType

      public final CustomServiceSettings.Builder inputType(Map<CustomServiceInputType,String> map)
      Specifies the input type translation values that are used to replace the ${input_type} template in the request body. For example: 
       "input_type": {
   "translation": {
     "ingest": "do_ingest",
     "search": "do_search"
   },
   "default": "a_default"
 },

      If the subsequent inference requests come from a search context, the search key will be used and the template will be replaced with do_search. If it comes from the ingest context do_ingest is used. If it's a different context that is not specified, the default value will be used. If no default is specified an empty string is used. translation can be:

      • classification
      • clustering
      • ingest
      • search

      API name: input_type

      Adds all entries of map to inputType.

    • inputType

      public final CustomServiceSettings.Builder inputType(CustomServiceInputType key, String value)
      Specifies the input type translation values that are used to replace the ${input_type} template in the request body. For example: 
       "input_type": {
   "translation": {
     "ingest": "do_ingest",
     "search": "do_search"
   },
   "default": "a_default"
 },

      If the subsequent inference requests come from a search context, the search key will be used and the template will be replaced with do_search. If it comes from the ingest context do_ingest is used. If it's a different context that is not specified, the default value will be used. If no default is specified an empty string is used. translation can be:

      • classification
      • clustering
      • ingest
      • search

      API name: input_type

      Adds an entry to inputType.

    • queryParameters

      public final CustomServiceSettings.Builder queryParameters(List<List<String>> list)
      Specifies the query parameters as a list of tuples. The arrays inside the query_parameters must have two items, a key and a value. For example: 
       "query_parameters":[
   ["param_key", "some_value"],
   ["param_key", "another_value"],
   ["other_key", "other_value"]
 ]

      If the base url is https://www.elastic.co it results in: https://www.elastic.co?param_key=some_value&param_key=another_value&other_key=other_value.

      API name: query_parameters

      Adds all elements of list to queryParameters.

    • queryParameters

      public final CustomServiceSettings.Builder queryParameters(List<String> value, List<String>... values)
      Specifies the query parameters as a list of tuples. The arrays inside the query_parameters must have two items, a key and a value. For example: 
       "query_parameters":[
   ["param_key", "some_value"],
   ["param_key", "another_value"],
   ["other_key", "other_value"]
 ]

      If the base url is https://www.elastic.co it results in: https://www.elastic.co?param_key=some_value&param_key=another_value&other_key=other_value.

      API name: query_parameters

      Adds one or more values to queryParameters.

    • request

      public final CustomServiceSettings.Builder request(CustomRequestParams value)
      Required - The request configuration object.

      API name: request

    • request

      public final CustomServiceSettings.Builder request(Function<CustomRequestParams.Builder,ObjectBuilder<CustomRequestParams>> fn)
      Required - The request configuration object.

      API name: request

    • response

      public final CustomServiceSettings.Builder response(CustomResponseParams value)
      Required - The response configuration object.

      API name: response

    • response

      public final CustomServiceSettings.Builder response(Function<CustomResponseParams.Builder,ObjectBuilder<CustomResponseParams>> fn)
      Required - The response configuration object.

      API name: response

    • secretParameters

      public final CustomServiceSettings.Builder secretParameters(Map<String,String> map)
      Required - Specifies secret parameters, like api_key or api_token, that are required to access the custom service. For example: 
       "secret_parameters":{
   "api_key":"<api_key>"
 }

      API name: secret_parameters

      Adds all entries of map to secretParameters.

    • secretParameters

      public final CustomServiceSettings.Builder secretParameters(String key, String value)
      Required - Specifies secret parameters, like api_key or api_token, that are required to access the custom service. For example: 
       "secret_parameters":{
   "api_key":"<api_key>"
 }

      API name: secret_parameters

      Adds an entry to secretParameters.

    • url

      public final CustomServiceSettings.Builder url(@Nullable String value)
      The URL endpoint to use for the requests.

      API name: url

    • self

      protected CustomServiceSettings.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<CustomServiceSettings.Builder>

    • build

      public CustomServiceSettings build()
      Builds a CustomServiceSettings.
      Specified by:
      build in interface ObjectBuilder<CustomServiceSettings>
      Throws:
      NullPointerException - if some of the required fields are null.