All Implemented Interfaces:


public final class CompletionCreateParams.CompletionCreateBody

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`CompletionCreateParams.CompletionCreateBody.Builder`	A builder for CompletionCreateBody.

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 Long`	`maxTokensToSample()`	The maximum number of tokens to generate before stopping.
`final Model`	`model()`	The model that will complete your prompt.
`final String`	`prompt()`	The prompt that you want Claude to complete.
`final Optional<Metadata>`	`metadata()`	An object describing metadata about the request.
`final Optional<List<String>>`	`stopSequences()`	Sequences that will cause the model to stop generating.
`final Optional<Double>`	`temperature()`	Amount of randomness injected into the response.
`final Optional<Long>`	`topK()`	Only sample from the top K options for each subsequent token.
`final Optional<Double>`	`topP()`	Use nucleus sampling.
`final JsonField<Long>`	`_maxTokensToSample()`	The maximum number of tokens to generate before stopping.
`final JsonField<Model>`	`_model()`	The model that will complete your prompt.
`final JsonField<String>`	`_prompt()`	The prompt that you want Claude to complete.
`final JsonField<Metadata>`	`_metadata()`	An object describing metadata about the request.
`final JsonField<List<String>>`	`_stopSequences()`	Sequences that will cause the model to stop generating.
`final JsonField<Double>`	`_temperature()`	Amount of randomness injected into the response.
`final JsonField<Long>`	`_topK()`	Only sample from the top K options for each subsequent token.
`final JsonField<Double>`	`_topP()`	Use nucleus sampling.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final CompletionCreateParams.CompletionCreateBody`	`validate()`
`final CompletionCreateParams.CompletionCreateBody.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static CompletionCreateParams.CompletionCreateBody.Builder`	`builder()`

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

- Constructor Detail
- Method Detail
  - maxTokensToSample
```
 final 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 Model model()
```
    The model that will complete your prompt.\n\nSee models for additional details and options.
  - prompt
```
 final 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 Optional<Metadata> metadata()
```
    An object describing metadata about the request.
  - stopSequences
```
 final Optional<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.
  - temperature
```
 final Optional<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 Optional<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 Optional<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.
  - _maxTokensToSample
```
 final 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 JsonField<Model> _model()
```
    The model that will complete your prompt.\n\nSee models for additional details and options.
  - _prompt
```
 final 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 JsonField<Metadata> _metadata()
```
    An object describing metadata about the request.
  - _stopSequences
```
 final 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.
  - _temperature
```
 final 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 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 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.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final CompletionCreateParams.CompletionCreateBody validate()
```
  - toBuilder
```
 final CompletionCreateParams.CompletionCreateBody.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static CompletionCreateParams.CompletionCreateBody.Builder builder()
```

Class CompletionCreateParams.CompletionCreateBody

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

maxTokensToSample

model

prompt

metadata

stopSequences

temperature

topK

topP

_maxTokensToSample

_model

_prompt

_metadata

_stopSequences

_temperature

_topK

_topP

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder