ConverseResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.bedrockruntime.model.ConverseResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConverseResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConverseResult()

Constructors
Constructor and Description
`ConverseResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConverseResult`	`clone()`
`boolean`	`equals(Object obj)`
`ConverseMetrics`	`getMetrics()` Metrics for the call to `Converse`.
`ConverseOutput`	`getOutput()` The result from the call to `Converse`.
`String`	`getStopReason()` The reason why the model stopped generating output.
`ConverseTrace`	`getTrace()` A trace object that contains information about the Guardrail behavior.
`TokenUsage`	`getUsage()` The total number of tokens used in the call to `Converse`.
`int`	`hashCode()`
`void`	`setMetrics(ConverseMetrics metrics)` Metrics for the call to `Converse`.
`void`	`setOutput(ConverseOutput output)` The result from the call to `Converse`.
`void`	`setStopReason(String stopReason)` The reason why the model stopped generating output.
`void`	`setTrace(ConverseTrace trace)` A trace object that contains information about the Guardrail behavior.
`void`	`setUsage(TokenUsage usage)` The total number of tokens used in the call to `Converse`.
`String`	`toString()` Returns a string representation of this object.
`ConverseResult`	`withMetrics(ConverseMetrics metrics)` Metrics for the call to `Converse`.
`ConverseResult`	`withOutput(ConverseOutput output)` The result from the call to `Converse`.
`ConverseResult`	`withStopReason(StopReason stopReason)` The reason why the model stopped generating output.
`ConverseResult`	`withStopReason(String stopReason)` The reason why the model stopped generating output.
`ConverseResult`	`withTrace(ConverseTrace trace)` A trace object that contains information about the Guardrail behavior.
`ConverseResult`	`withUsage(TokenUsage usage)` The total number of tokens used in the call to `Converse`.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConverseResult
```
public ConverseResult()
```
- Method Detail
  - setOutput
```
public void setOutput(ConverseOutput output)
```
    The result from the call to Converse.
    
    Parameters:
    
    output - The result from the call to Converse.
  - getOutput
```
public ConverseOutput getOutput()
```
    The result from the call to Converse.
    
    Returns:
    
    The result from the call to Converse.
  - withOutput
```
public ConverseResult withOutput(ConverseOutput output)
```
    The result from the call to Converse.
    
    Parameters:
    
    output - The result from the call to Converse.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStopReason
```
public void setStopReason(String stopReason)
```
    The reason why the model stopped generating output.
    
    Parameters:
    
    stopReason - The reason why the model stopped generating output.
    
    See Also:
    
    StopReason
  - getStopReason
```
public String getStopReason()
```
    The reason why the model stopped generating output.
    
    Returns:
    
    The reason why the model stopped generating output.
    
    See Also:
    
    StopReason
  - withStopReason
```
public ConverseResult withStopReason(String stopReason)
```
    The reason why the model stopped generating output.
    
    Parameters:
    
    stopReason - The reason why the model stopped generating output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StopReason
  - withStopReason
```
public ConverseResult withStopReason(StopReason stopReason)
```
    The reason why the model stopped generating output.
    
    Parameters:
    
    stopReason - The reason why the model stopped generating output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StopReason
  - setUsage
```
public void setUsage(TokenUsage usage)
```
    The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.
    
    Parameters:
    
    usage - The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.
  - getUsage
```
public TokenUsage getUsage()
```
    The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.
    
    Returns:
    
    The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.
  - withUsage
```
public ConverseResult withUsage(TokenUsage usage)
```
    The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.
    
    Parameters:
    
    usage - The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetrics
```
public void setMetrics(ConverseMetrics metrics)
```
    Metrics for the call to Converse.
    
    Parameters:
    
    metrics - Metrics for the call to Converse.
  - getMetrics
```
public ConverseMetrics getMetrics()
```
    Metrics for the call to Converse.
    
    Returns:
    
    Metrics for the call to Converse.
  - withMetrics
```
public ConverseResult withMetrics(ConverseMetrics metrics)
```
    Metrics for the call to Converse.
    
    Parameters:
    
    metrics - Metrics for the call to Converse.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrace
```
public void setTrace(ConverseTrace trace)
```
    A trace object that contains information about the Guardrail behavior.
    
    Parameters:
    
    trace - A trace object that contains information about the Guardrail behavior.
  - getTrace
```
public ConverseTrace getTrace()
```
    A trace object that contains information about the Guardrail behavior.
    
    Returns:
    
    A trace object that contains information about the Guardrail behavior.
  - withTrace
```
public ConverseResult withTrace(ConverseTrace trace)
```
    A trace object that contains information about the Guardrail behavior.
    
    Parameters:
    
    trace - A trace object that contains information about the Guardrail behavior.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ConverseResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.793

Class ConverseResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

ConverseResult

Method Detail

setOutput

getOutput

withOutput

setStopReason

getStopReason

withStopReason

withStopReason

setUsage

getUsage

withUsage

setMetrics

getMetrics

withMetrics

setTrace

getTrace

withTrace

toString

equals

hashCode

clone