java/resources/conversations/methods/delete/index.md +0 −56 deleted
File Deleted View Diff
1## Delete a conversation
2
3`ConversationDeletedResource conversations().delete(ConversationDeleteParamsparams = ConversationDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`
4
5**delete** `/conversations/{conversation_id}`
6
7Delete a conversation. Items in the conversation will not be deleted.
8
9### Parameters
10
11- `ConversationDeleteParams params`
12
13 - `Optional<String> conversationId`
14
15### Returns
16
17- `class ConversationDeletedResource:`
18
19 - `String id`
20
21 - `boolean deleted`
22
23 - `JsonValue; object_ "conversation.deleted"constant`
24
25 - `CONVERSATION_DELETED("conversation.deleted")`
26
27### Example
28
29```java
30package com.openai.example;
31
32import com.openai.client.OpenAIClient;
33import com.openai.client.okhttp.OpenAIOkHttpClient;
34import com.openai.models.conversations.ConversationDeleteParams;
35import com.openai.models.conversations.ConversationDeletedResource;
36
37public final class Main {
38 private Main() {}
39
40 public static void main(String[] args) {
41 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
42
43 ConversationDeletedResource conversationDeletedResource = client.conversations().delete("conv_123");
44 }
45}
46```
47
48#### Response
49
50```json
51{
52 "id": "id",
53 "deleted": true,
54 "object": "conversation.deleted"
55}
56```