Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@ The **OCI OpenAI Java** library provides secure and convenient access to the Ope

## Table of Contents
- [oci-openai-java](#oci-openai-java)
- [Table of Contents](#table-of-contents)
- [Before You Start](#before-you-start)
- [Installation](#installation)
- [Examples](#examples)
- [Signers](#signers)
- [Contributing](#contributing)
- [Security](#security)
- [License](#license)
- [Table of Contents](#table-of-contents)
- [Before You Start](#before-you-start)
- [Installation](#installation)
- [Usage](#usage)
- [Quick Start](#quick-start)
- [Authentication](#authentication)
- [Client Initialization Parameters](#client-initialization-parameters)
- [Base URL and endpoint overrides](#base-url-and-endpoint-overrides)
- [Error Handling](#error-handling)
- [Cleanup](#cleanup)
- [Examples](#examples)
- [Third-Party APIs](#third-party-apis)
- [Contributing](#contributing)
- [Security](#security)
- [License](#license)

---

Expand Down
63 changes: 60 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,14 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.oracle.genai</groupId>
<artifactId>oci-openai-java-sdk</artifactId>
<version>0.1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>OCI OpenAI Java SDK</name>
<description>Helper utilities for using the OpenAI Java SDK against OCI Generative AI endpoints.</description>

<url>https://github.com/oracle/oci-openai-java</url>
<licenses>
<license>
<name>The Universal Permissive License (UPL), Version 1.0</name>
<url>https://oss.oracle.com/licenses/upl/</url>
</license>
</licenses>
<developers>
<developer>
<id>oracle</id>
<name>Oracle</name>
<organizationUrl>https://www.oracle.com</organizationUrl>
</developer>
</developers>
<scm>
<url>https://github.com/oracle/oci-openai-java</url>
<connection>scm:git:git@github.com:oracle/oci-openai-java.git</connection>
<developerConnection>scm:git:git@github.com:oracle/oci-openai-java.git</developerConnection>
</scm>
<properties>
<java.version>17</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
Expand Down Expand Up @@ -100,7 +118,46 @@
<useModulePath>false</useModulePath>
</configuration>
</plugin>

<!-- Plugin to generate sources jar -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.3.0</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- Plugin to generate javadoc jar -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.0</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
<resources>
<resource>
<directory>${project.basedir}</directory>
<includes>
<!-- Add LICENSE.txt from the root directory -->
<include>LICENSE.txt</include>
<!-- Add THIRD_PARTY_LICENSES.txt from the root directory -->
<include>THIRD_PARTY_LICENSES.txt</include>
</includes>
<targetPath>META-INF</targetPath>
</resource>
</resources>
</build>
</project>