All Implemented Interfaces:


public final class CompletionCreateParams.Builder

A builder for CompletionCreateParams.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final CompletionCreateParams.Builder`	`maxTokensToSample(Long maxTokensToSample)`	The maximum number of tokens to generate before stopping.
`final CompletionCreateParams.Builder`	`maxTokensToSample(JsonField<Long> maxTokensToSample)`	The maximum number of tokens to generate before stopping.
`final CompletionCreateParams.Builder`	`model(Model model)`	The model that will complete your prompt.
`final CompletionCreateParams.Builder`	`model(JsonField<Model> model)`	The model that will complete your prompt.
`final CompletionCreateParams.Builder`	`model(String value)`	The model that will complete your prompt.
`final CompletionCreateParams.Builder`	`prompt(String prompt)`	The prompt that you want Claude to complete.
`final CompletionCreateParams.Builder`	`prompt(JsonField<String> prompt)`	The prompt that you want Claude to complete.
`final CompletionCreateParams.Builder`	`metadata(Metadata metadata)`	An object describing metadata about the request.
`final CompletionCreateParams.Builder`	`metadata(JsonField<Metadata> metadata)`	An object describing metadata about the request.
`final CompletionCreateParams.Builder`	`stopSequences(List<String> stopSequences)`	Sequences that will cause the model to stop generating.
`final CompletionCreateParams.Builder`	`stopSequences(JsonField<List<String>> stopSequences)`	Sequences that will cause the model to stop generating.
`final CompletionCreateParams.Builder`	`addStopSequence(String stopSequence)`	Sequences that will cause the model to stop generating.
`final CompletionCreateParams.Builder`	`temperature(Double temperature)`	Amount of randomness injected into the response.
`final CompletionCreateParams.Builder`	`temperature(JsonField<Double> temperature)`	Amount of randomness injected into the response.
`final CompletionCreateParams.Builder`	`topK(Long topK)`	Only sample from the top K options for each subsequent token.
`final CompletionCreateParams.Builder`	`topK(JsonField<Long> topK)`	Only sample from the top K options for each subsequent token.
`final CompletionCreateParams.Builder`	`topP(Double topP)`	Use nucleus sampling.
`final CompletionCreateParams.Builder`	`topP(JsonField<Double> topP)`	Use nucleus sampling.
`final CompletionCreateParams.Builder`	`additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)`
`final CompletionCreateParams.Builder`	`putAdditionalBodyProperty(String key, JsonValue value)`
`final CompletionCreateParams.Builder`	`putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)`
`final CompletionCreateParams.Builder`	`removeAdditionalBodyProperty(String key)`
`final CompletionCreateParams.Builder`	`removeAllAdditionalBodyProperties(Set<String> keys)`
`final CompletionCreateParams.Builder`	`additionalHeaders(Headers additionalHeaders)`
`final CompletionCreateParams.Builder`	`additionalHeaders(Map<String, Iterable<String>> additionalHeaders)`
`final CompletionCreateParams.Builder`	`putAdditionalHeader(String name, String value)`
`final CompletionCreateParams.Builder`	`putAdditionalHeaders(String name, Iterable<String> values)`
`final CompletionCreateParams.Builder`	`putAllAdditionalHeaders(Headers additionalHeaders)`
`final CompletionCreateParams.Builder`	`putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)`
`final CompletionCreateParams.Builder`	`replaceAdditionalHeaders(String name, String value)`
`final CompletionCreateParams.Builder`	`replaceAdditionalHeaders(String name, Iterable<String> values)`
`final CompletionCreateParams.Builder`	`replaceAllAdditionalHeaders(Headers additionalHeaders)`
`final CompletionCreateParams.Builder`	`replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)`
`final CompletionCreateParams.Builder`	`removeAdditionalHeaders(String name)`
`final CompletionCreateParams.Builder`	`removeAllAdditionalHeaders(Set<String> names)`
`final CompletionCreateParams.Builder`	`additionalQueryParams(QueryParams additionalQueryParams)`
`final CompletionCreateParams.Builder`	`additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)`
`final CompletionCreateParams.Builder`	`putAdditionalQueryParam(String key, String value)`
`final CompletionCreateParams.Builder`	`putAdditionalQueryParams(String key, Iterable<String> values)`
`final CompletionCreateParams.Builder`	`putAllAdditionalQueryParams(QueryParams additionalQueryParams)`
`final CompletionCreateParams.Builder`	`putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)`
`final CompletionCreateParams.Builder`	`replaceAdditionalQueryParams(String key, String value)`
`final CompletionCreateParams.Builder`	`replaceAdditionalQueryParams(String key, Iterable<String> values)`
`final CompletionCreateParams.Builder`	`replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)`
`final CompletionCreateParams.Builder`	`replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)`
`final CompletionCreateParams.Builder`	`removeAdditionalQueryParams(String key)`
`final CompletionCreateParams.Builder`	`removeAllAdditionalQueryParams(Set<String> keys)`
`final CompletionCreateParams`	`build()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - maxTokensToSample
```
 final CompletionCreateParams.Builder maxTokensToSample(Long maxTokensToSample)
```
    The maximum number of tokens to generate before stopping.
    Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
  - maxTokensToSample
```
 final CompletionCreateParams.Builder maxTokensToSample(JsonField<Long> maxTokensToSample)
```
    The maximum number of tokens to generate before stopping.
    Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
  - model
```
 final CompletionCreateParams.Builder model(Model model)
```
    The model that will complete your prompt.\n\nSee models for additional details and options.
  - model
```
 final CompletionCreateParams.Builder model(JsonField<Model> model)
```
    The model that will complete your prompt.\n\nSee models for additional details and options.
  - model
```
 final CompletionCreateParams.Builder model(String value)
```
    The model that will complete your prompt.\n\nSee models for additional details and options.
  - prompt
```
 final CompletionCreateParams.Builder prompt(String prompt)
```
    The prompt that you want Claude to complete.
    For proper response generation you will need to format your prompt using alternating \n\nHuman: and \n\nAssistant: conversational turns. For example:
    "\n\nHuman: {userQuestion}\n\nAssistant:"
    See prompt validation and our guide to prompt design for more details.
  - prompt
```
 final CompletionCreateParams.Builder prompt(JsonField<String> prompt)
```
    The prompt that you want Claude to complete.
    For proper response generation you will need to format your prompt using alternating \n\nHuman: and \n\nAssistant: conversational turns. For example:
    "\n\nHuman: {userQuestion}\n\nAssistant:"
    See prompt validation and our guide to prompt design for more details.
  - metadata
```
 final CompletionCreateParams.Builder metadata(Metadata metadata)
```
    An object describing metadata about the request.
  - metadata
```
 final CompletionCreateParams.Builder metadata(JsonField<Metadata> metadata)
```
    An object describing metadata about the request.
  - stopSequences
```
 final CompletionCreateParams.Builder stopSequences(List<String> stopSequences)
```
    Sequences that will cause the model to stop generating.
    Our models stop on "\n\nHuman:", and may include additional built-in stop sequences in the future. By providing the stop_sequences parameter, you may include additional strings that will cause the model to stop generating.
  - stopSequences
```
 final CompletionCreateParams.Builder stopSequences(JsonField<List<String>> stopSequences)
```
    Sequences that will cause the model to stop generating.
    Our models stop on "\n\nHuman:", and may include additional built-in stop sequences in the future. By providing the stop_sequences parameter, you may include additional strings that will cause the model to stop generating.
  - addStopSequence
```
 final CompletionCreateParams.Builder addStopSequence(String stopSequence)
```
    Sequences that will cause the model to stop generating.
    Our models stop on "\n\nHuman:", and may include additional built-in stop sequences in the future. By providing the stop_sequences parameter, you may include additional strings that will cause the model to stop generating.
  - temperature
```
 final CompletionCreateParams.Builder temperature(Double temperature)
```
    Amount of randomness injected into the response.
    Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.
    Note that even with temperature of 0.0, the results will not be fully deterministic.
  - temperature
```
 final CompletionCreateParams.Builder temperature(JsonField<Double> temperature)
```
    Amount of randomness injected into the response.
    Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.
    Note that even with temperature of 0.0, the results will not be fully deterministic.
  - topK
```
 final CompletionCreateParams.Builder topK(Long topK)
```
    Only sample from the top K options for each subsequent token.
    Used to remove "long tail" low probability responses. Learn more technical details here.
    Recommended for advanced use cases only. You usually only need to use temperature.
  - topK
```
 final CompletionCreateParams.Builder topK(JsonField<Long> topK)
```
    Only sample from the top K options for each subsequent token.
    Used to remove "long tail" low probability responses. Learn more technical details here.
    Recommended for advanced use cases only. You usually only need to use temperature.
  - topP
```
 final CompletionCreateParams.Builder topP(Double topP)
```
    Use nucleus sampling.
    In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.
    Recommended for advanced use cases only. You usually only need to use temperature.
  - topP
```
 final CompletionCreateParams.Builder topP(JsonField<Double> topP)
```
    Use nucleus sampling.
    In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.
    Recommended for advanced use cases only. You usually only need to use temperature.
  - additionalBodyProperties
```
 final CompletionCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
```
  - putAdditionalBodyProperty
```
 final CompletionCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)
```
  - putAllAdditionalBodyProperties
```
 final CompletionCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
```
  - removeAdditionalBodyProperty
```
 final CompletionCreateParams.Builder removeAdditionalBodyProperty(String key)
```
  - removeAllAdditionalBodyProperties
```
 final CompletionCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)
```
  - additionalHeaders
```
 final CompletionCreateParams.Builder additionalHeaders(Headers additionalHeaders)
```
  - additionalHeaders
```
 final CompletionCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
```
  - putAdditionalHeader
```
 final CompletionCreateParams.Builder putAdditionalHeader(String name, String value)
```
  - putAdditionalHeaders
```
 final CompletionCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
```
  - putAllAdditionalHeaders
```
 final CompletionCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
```
  - putAllAdditionalHeaders
```
 final CompletionCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
```
  - replaceAdditionalHeaders
```
 final CompletionCreateParams.Builder replaceAdditionalHeaders(String name, String value)
```
  - replaceAdditionalHeaders
```
 final CompletionCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
```
  - replaceAllAdditionalHeaders
```
 final CompletionCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
```
  - replaceAllAdditionalHeaders
```
 final CompletionCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
```
  - removeAdditionalHeaders
```
 final CompletionCreateParams.Builder removeAdditionalHeaders(String name)
```
  - removeAllAdditionalHeaders
```
 final CompletionCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)
```
  - additionalQueryParams
```
 final CompletionCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
```
  - additionalQueryParams
```
 final CompletionCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
```
  - putAdditionalQueryParam
```
 final CompletionCreateParams.Builder putAdditionalQueryParam(String key, String value)
```
  - putAdditionalQueryParams
```
 final CompletionCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
```
  - putAllAdditionalQueryParams
```
 final CompletionCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
```
  - putAllAdditionalQueryParams
```
 final CompletionCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
```
  - replaceAdditionalQueryParams
```
 final CompletionCreateParams.Builder replaceAdditionalQueryParams(String key, String value)
```
  - replaceAdditionalQueryParams
```
 final CompletionCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
```
  - replaceAllAdditionalQueryParams
```
 final CompletionCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
```
  - replaceAllAdditionalQueryParams
```
 final CompletionCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
```
  - removeAdditionalQueryParams
```
 final CompletionCreateParams.Builder removeAdditionalQueryParams(String key)
```
  - removeAllAdditionalQueryParams
```
 final CompletionCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
```
  - build
```
 final CompletionCreateParams build()
```

Class CompletionCreateParams.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

maxTokensToSample

maxTokensToSample

model

model

model

prompt

prompt

metadata

metadata

stopSequences

stopSequences

addStopSequence

temperature

temperature

topK

topK

topP

topP

additionalBodyProperties

putAdditionalBodyProperty

putAllAdditionalBodyProperties

removeAdditionalBodyProperty

removeAllAdditionalBodyProperties

additionalHeaders

additionalHeaders

putAdditionalHeader

putAdditionalHeaders

putAllAdditionalHeaders

putAllAdditionalHeaders

replaceAdditionalHeaders

replaceAdditionalHeaders

replaceAllAdditionalHeaders

replaceAllAdditionalHeaders

removeAdditionalHeaders

removeAllAdditionalHeaders

additionalQueryParams

additionalQueryParams

putAdditionalQueryParam

putAdditionalQueryParams

putAllAdditionalQueryParams

putAllAdditionalQueryParams

replaceAdditionalQueryParams

replaceAdditionalQueryParams

replaceAllAdditionalQueryParams

replaceAllAdditionalQueryParams

removeAdditionalQueryParams

removeAllAdditionalQueryParams

build