-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.ai.openai.models.Completions.yml
112 lines (112 loc) · 8.56 KB
/
com.azure.ai.openai.models.Completions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
### YamlMime:JavaType
uid: "com.azure.ai.openai.models.Completions"
fullName: "com.azure.ai.openai.models.Completions"
name: "Completions"
nameWithType: "Completions"
summary: "Representation of the response data from a completions request."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **Completions**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.openai.models.Completions?alt=com.azure.ai.openai.models.Completions&text=Completions\" data-throw-if-not-resolved=\"False\" />>"
methods:
- uid: "com.azure.ai.openai.models.Completions.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.ai.openai.models.Completions.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "Completions.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Completions from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static Completions fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of Completions from the JsonReader."
returns:
description: "An instance of Completions if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.ai.openai.models.Completions?alt=com.azure.ai.openai.models.Completions&text=Completions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.Completions.getChoices()"
fullName: "com.azure.ai.openai.models.Completions.getChoices()"
name: "getChoices()"
nameWithType: "Completions.getChoices()"
summary: "Get the choices property: The collection of completions choices associated with this completions response."
syntax: "public List<Choice> getChoices()"
desc: "Get the choices property: The collection of completions choices associated with this completions response. Generally, \\`n\\` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated."
returns:
description: "the choices value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.openai.models.Choice?alt=com.azure.ai.openai.models.Choice&text=Choice\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.ai.openai.models.Completions.getCreatedAt()"
fullName: "com.azure.ai.openai.models.Completions.getCreatedAt()"
name: "getCreatedAt()"
nameWithType: "Completions.getCreatedAt()"
summary: "Get the created<wbr>At property: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970."
syntax: "public OffsetDateTime getCreatedAt()"
desc: "Get the createdAt property: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970."
returns:
description: "the createdAt value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.ai.openai.models.Completions.getId()"
fullName: "com.azure.ai.openai.models.Completions.getId()"
name: "getId()"
nameWithType: "Completions.getId()"
summary: "Get the id property: A unique identifier associated with this completions response."
syntax: "public String getId()"
desc: "Get the id property: A unique identifier associated with this completions response."
returns:
description: "the id value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.openai.models.Completions.getPromptFilterResults()"
fullName: "com.azure.ai.openai.models.Completions.getPromptFilterResults()"
name: "getPromptFilterResults()"
nameWithType: "Completions.getPromptFilterResults()"
summary: "Get the prompt<wbr>Filter<wbr>Results property: Content filtering results for zero or more prompts in the request."
syntax: "public List<ContentFilterResultsForPrompt> getPromptFilterResults()"
desc: "Get the promptFilterResults property: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders."
returns:
description: "the promptFilterResults value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.openai.models.ContentFilterResultsForPrompt?alt=com.azure.ai.openai.models.ContentFilterResultsForPrompt&text=ContentFilterResultsForPrompt\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.ai.openai.models.Completions.getUsage()"
fullName: "com.azure.ai.openai.models.Completions.getUsage()"
name: "getUsage()"
nameWithType: "Completions.getUsage()"
summary: "Get the usage property: Usage information for tokens processed and generated as part of this completions operation."
syntax: "public CompletionsUsage getUsage()"
desc: "Get the usage property: Usage information for tokens processed and generated as part of this completions operation."
returns:
description: "the usage value."
type: "<xref href=\"com.azure.ai.openai.models.CompletionsUsage?alt=com.azure.ai.openai.models.CompletionsUsage&text=CompletionsUsage\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.Completions.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.ai.openai.models.Completions.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "Completions.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Representation of the response data from a completions request. Completions support a wide variety of tasks and generate text that continues from or \"completes\" provided prompt data."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.openai.models.Completions?alt=com.azure.ai.openai.models.Completions&text=Completions\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.azure.ai.openai.models"
artifact: com.azure:azure-ai-openai:1.0.0-beta.10